数美文本人工审核API接口文档#


版权所有 翻版必究


1.API接口描述#

1.1请求参数#

请求URL:

北京:http://api-audit-bj.fengkongcloud.com/audit/text/v1

字符编码格式: UTF-8字符集编码

请求方法: POST

建议超时时长: 5s

请求参数:

放在HTTP Body中,采用Json格式,具体参数如下:

请求参数名类型参数说明传入说明备注
accessKeystring接口认证密钥必传参数由数美提供
appIdstring应用标识非必传参数用于区分应用,需要联系数美开通,请使用数美单独提供的传值为准
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB
resultjson_object机审结果信息非必传参数

其中,data的内容如下:

请求参数名类型参数说明是否必传备注
textstring要审核的文本内容必传参数
tokenIdstring用户账号标识必传参数
channelstring渠道,用于区分不通数据审核要求不一致问题非必传参数
passThroughJson_object透传字段,这里面的内容都会透传给回调接口,业务用于使用非必传参数

其中,result的内容如下:

请求参数名类型参数说明是否必传备注
riskLevelstring处置建议必传参数取机审返回的处置建议
riskLabel1string一级风险标签必传参数取机审返回的一级风险标签
riskLabel2string二级风险标签必传参数取机审返回的二级风险标签
riskLabel3string三级风险标签必传参数取机审返回的三级风险标签
riskDescriptionstring风险原因必传参数取机审返回的风险原因

1.2返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称参数类型参数说明是否必返备注
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
9101:无权限操作
messagestring返回码描述和code对应:
成功
QPS超限
参数不合法
服务失败
无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存

1.3示例#

请求示例

{
"accessKey": "xxxx",
"appId": "default",
"data": {
"tokenId": "df6afc8badc44130a37677b700b67f30",
"text": "阿斗先生",
"channel": "default",
"passThrough": {
}
},
"result": {
"riskLevel": "REJECT",
"riskLabel1": "ad",
"riskLabel2": "ad",
"riskLabel3": "ad",
"riskDescription": "广告:广告:广告"
}
}

在线咨询