文本提交接口
2024.09.25 11:34:06
接口地址
http://as.dun.163.com/v4/text/check
接口描述
建议您使用POST请求, 且仅接受 application/x-www-form-urlencoded 编码格式。
根据发布的内容、发布者、ip、设备等信息来检测是否为需拦截内容。接口同步返回易盾内容安全服务实时反垃圾引擎检测结果，产品可以根据该结果对数据进行初步过滤。该接口返回结果状态分以下三种：
- 不通过：表示是确认内容非法，产品可对数据做删除隐藏处理。
- 嫌疑：表示该内容疑似非法，需内容安全云服务离线检测模块进一步确认处理，确认结果需产品自行定期调用文本离线检测结果获取获取，产品对嫌疑数据可以做特殊策略处理，如本人可见等。
- 通过：表示云安全反垃圾云服务实时反垃圾引擎未识别为非法内容，产品对该类数据可以直接放过，发表成功。云安全反垃圾云服务离线检测模块也会对这些数据做进一步分析处理，分析结果需产品自行定期调用文本离线检测结果获取获取。
文本限制
单次请求<1万字符，字段长度超过1万字符，会截取前面1万字符进行检测和存储；
请求参数
公共参数已省略，详细见 请求公共参数，其他参数如下：
基本参数
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| dataId | String | Y | 128 | 数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询 |
| content | String | Y | 10000 | 用户发表内容，建议对内容中JSON、表情符、HTML标签、UBB标签等做过滤，只传递纯文本，以减少误判概率 |
| title | String | N | 512 | 内容标题，适用于贴子、博客的文章标题等场景，建议抄送，辅助机审策略精准调优 |
| dataType | Number | N | 4 | 子数据类型，与易盾内容安全服务约定即可 |
| version | String | Y | 4 | 接口版本号，可选值 v4.2 |
| callback | String | N | 2^16-1 | 数据回调参数，调用方根据业务情况自行设计，当调用文本离线结果获取接口时，该接口会原样返回该字段，详细见文本离线检测结果获取。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。 |
| publishTime | Number | N | 13 | 发表时间，UNIX 时间戳(毫秒值) |
| callbackUrl | String | N | 256 | 人工审核结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。 |
| checkLabels | String | N | 512 | 业务自定义过检分类,请谨慎写入，并于策略经理充分沟通，以免引起漏判，如果没有勾选分类提交返回参数错误，您可指定多个垃圾类别进行机器检测，多个垃圾类别以逗号分隔（"100,200"），指定后业务配置过检分类即失效，过检分类列表：100：色情，200：广告，260：广告法，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水，900：其他，1100：涉价值观 |
| category | String | N | 128 | 来源，用于展示渠道名称，应用名称等 |
| subProduct | String | N | 32 | 业务结算id(自定义),业务方传入参数，用于资源账单统计,如需开启请联系易盾客户经理。开启之后资源账单按套餐结算sheet增加subProduct维度的数据请求量、检测量、消耗金额的统计 |
业务扩展参数
业务扩展参数，有助于通过业务维度辅助反垃圾结果判定
| 参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
|---|---|---|---|---|
| 用户信息 | - | N | - | 用户信息包含账号、昵称、等级、角色等，请查看 业务扩展参数—用户信息 |
| 设备信息 | - | N | - | 设备信息包含设备ID、设备ID类型等，请查看 业务扩展参数—设备信息 |
| 场景信息 | - | N | - | 场景信息包含私聊、群聊、直播、帖子等场景字段，请查看 业务扩展参数—场景信息 |
| ip | String | N | 128 | 用户IP地址，建议抄送，辅助机审策略精准调优 |
| relatedKeys | String | N | 512 | String数组，多个关联Key以逗号分隔（"xxx,xxx"），最多三个Key，单个Key长度不超过128，适用于私聊/评论/跟帖等情况同一用户或不同用户发送多条违规内容关联检测的场景。如需要检测同一评论下的同一用户或不同用户发送违规内容盖楼场景，Key传值方式可以为（"评论ID,用户ID"） |
| extStr1 | String | N | 128 | 自定义扩展参数 |
| extStr2 | String | N | 128 | 自定义扩展参数 |
| extLon1 | Long | N | 2^63-1 | 自定义扩展参数 |
| extLon2 | Long | N | 2^63-1 | 自定义扩展参数 |
| extension | String | N | 30000 | 自定义扩展参数 |
响应结果
响应字段如下，响应通用字段已省略，详细见响应通用字段：
result数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| antispam | Json对象 | 文本反垃圾检测结果 |
| anticheat | Json对象 | 反作弊检测结果，如有需要请联系您的专属商务，未开通状态下json对象返回为空 |
| emotionAnalysis | Json对象 | 情感分析检测结果，如有需要请联系您的专属商务，未开通状态下json对象返回为空 |
| userRisk | Json对象 | 用户画像检测结果，如有需要请联系您的专属商务，未开通状态下json对象返回为空 |
反垃圾结果
antispam 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| action | Number | 建议动作，2：建议删除，1：建议审核，0：建议通过 |
| censorType | Number | 审核模式，0：纯机审，1：机审+部分人审，2：机审+全量人审 |
| strategyVersion | String | 策略版本号,策略更新时该参数会更新，可用于追溯策略调优效果 |
| taskId | String | 本次请求数据标识，可以根据该标识查询数据最新结果 |
| lang | Json数组 | 语种代码数组，详见 语种代码表 |
| isRelatedHit | Boolean | 是否关联检测命中，true：关联检测命中，false：原文命中 |
| labels | Json数组 | 分类信息 |
labels 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| label | Number | 分类信息，100：色情，200：广告，260：广告法，300：暴恐，400：违禁，500：涉政，600：谩骂，700：灌水，900：其他，1100：涉价值观 |
| subLabels | json数组 | 细分类信息，可能包含多个，可能为空 |
| level | Number | 分类级别，0：正常， 1：不确定，2：确定 |
| details | json对象 | 其他信息 |
subLabels 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| subLabel | Number | 细分类，详细编码请参考下方对应细分类编码对照表 |
自定义细分类
易盾支持subLabel自定义细分类过检并返回，如有需求，可联系您的专属安全策略经理添加。
details 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| hint | Json数组 | 线索信息，用于定位文本中有问题的部分，辅助人工审核。接口版本v4及以下返回 |
| hints | Json数组 | hint字段内容+线索命中的坐标信息，仅接口版本v4.1及以上会返回该字段 |
| hitInfos | Json数组 | 线索详细信息 |
hints 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| hint | String | 线索信息 |
| positions | Json数组 | 线索命中的坐标信息 |
positions数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| positionType | Number | 位置类型，0：内容，1：标题 |
| startPos | Number | 线索起始坐标，如果命中第一个字符，起始坐标返回0 |
| endPos | Number | 线索结束坐标，如果命中第一个字符，结束坐标返回1 |
hitInfos 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| hitType | Number | 线索分类信息，返回10:表示命中用户自定义添加用户名单，返回11:表示命中用户自定义添加ip名单，返回30:表示命中用户自定义添加敏感词,返回140：标识命中反作弊（hitReason为反作弊命中原因，1：数据异常 2：行为模型 3：设备模型 4：业务类型 5：校验异常 6：模拟器 7：越狱或root 8：浏览器异常 9：ip异常 10：易盾黑名单 11：自定义黑名单 12：自定义白名单） |
| hitClues | Json数组 | hitType命中30自定义添加敏感词，返回命中的自定义敏感词内容,如果没有命中hitType：30,则不返回该字段 |
情感分析结果
emotionAnalysis 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | String | 本次请求数据标识，可以根据该标识查询数据最新结果 |
| sentiment | String | negative（负向情绪），neutral（中性情绪），positive（正向情绪），unknown（未知） |
| positiveProb | Number | 0~1，代表正向情绪倾向，分数越高，正向情绪越高 |
| negativeProb | number | 0~1，代表负向情绪倾向，分数越高，负向情绪越高 |
反作弊结果
anticheat 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | String | 本次请求数据标识，可以根据该标识查询数据最新结果 |
| action | Number | 检测结果，0：通过，10：嫌疑，20：不通过 |
| hitInfos | Json数组 | 命中信息，例如：[{"hitType":5,"hitMsg":"无SDK数据"}]，其中hitType类型为int，含义是命中类型，详见 hitType返回码及含义表 ，hitMsg类型为String，含义是命中详情，可定制返回值。 |
用户画像结果
userRisk 数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | String | 本次请求数据标识，可以根据该标识查询数据最新结果 |
| dataId | String | 本次请求提交的客户数据标识 |
| account | String | 用户账号信息 |
| accountLevel | Number | 用户账号风险等级，0：正常，1：嫌疑，2：确定 |
响应示例
结果为不通过时，输出示例如下：
{
"code":200,
"msg":"ok",
"result":{
"antispam":{
"taskId":"fx6sxdcd89fvbvg4967b4787d78a",
"action":1,
"censorType":0,
"lang":[
"en",
"vi"
],
"isRelatedHit":false,
"labels":[
{
"label":100,
"level":1,
"details":{
"hint":[
"xxx,ooo"
],
"hitInfos":[
]
},
"subLabels":[
{
"subLabel":"100002"
}
]
}
]
},
"emotionAnalysis":{
"taskId":"fx6sxdcd89fvbvg4967b4787d78a",
"sentiment":"positive",
"positiveProb":0.95,
"negativeProb":0.05
},
"anticheat":{
"taskId":"fx6sxdcd89fvbvg4967b4787d78a",
"action":0,
"hitInfos":[
{
"hitType":0
}
]
},
"userRisk":{
}
}
}
结果为通过时，输出示例如下：
{
"code":200,
"msg":"ok",
"result":{
"antispam":{
"taskId":"9318dfd1783f4eb1ba1449248abeaad8",
"action":0,
"censorType":0,
"isRelatedHit":false,
"lang":[
],
"labels":[
],
"censorLabels":[
]
},
"emotionAnalysis":{
},
"anticheat":{
},
"userRisk":{
}
}
}
