数美文本人工审核API接口文档#
版权所有 翻版必究
1.API接口描述#
1.1请求参数#
请求URL:
北京:http://api-audit-bj.fengkongcloud.com/audit/text/v1
字符编码格式: UTF-8字符集编码
请求方法: POST
建议超时时长: 5s
请求参数:
放在HTTP Body中,采用Json格式,具体参数如下:
| 请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
|---|---|---|---|---|
| accessKey | string | 接口认证密钥 | 必传参数 | 由数美提供 |
| appId | string | 应用标识 | 非必传参数 | 用于区分应用,需要联系数美开通,请使用数美单独提供的传值为准 |
| data | json_object | 请求的数据内容 | 必传参数 | 请求的数据内容,最长10MB |
| result | json_object | 机审结果信息 | 非必传参数 |
其中,data的内容如下:
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 备注 |
|---|---|---|---|---|
| text | string | 要审核的文本内容 | 必传参数 | |
| tokenId | string | 用户账号标识 | 必传参数 | |
| channel | string | 渠道,用于区分不通数据审核要求不一致问题 | 非必传参数 | |
| passThrough | Json_object | 透传字段,这里面的内容都会透传给回调接口,业务用于使用 | 非必传参数 |
其中,result的内容如下:
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 备注 |
|---|---|---|---|---|
| riskLevel | string | 处置建议 | 必传参数 | 取机审返回的处置建议 |
| riskLabel1 | string | 一级风险标签 | 必传参数 | 取机审返回的一级风险标签 |
| riskLabel2 | string | 二级风险标签 | 必传参数 | 取机审返回的二级风险标签 |
| riskLabel3 | string | 三级风险标签 | 必传参数 | 取机审返回的三级风险标签 |
| riskDescription | string | 风险原因 | 必传参数 | 取机审返回的风险原因 |
1.2返回结果#
放在HTTP Body中,采用Json格式,具体参数如下:
| 参数名称 | 参数类型 | 参数说明 | 是否必返 | 备注 |
|---|---|---|---|---|
| code | int | 返回码 | 是 | 1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 9101:无权限操作 |
| message | string | 返回码描述 | 是 | 和code对应: 成功 QPS超限 参数不合法 服务失败 无权限操作 |
| requestId | string | 请求标识 | 是 | 请求唯一标识,用于排查问题和后续效果优化,强烈建议保存 |
1.3示例#
请求示例
