数美智能网页识别产品API接口文档#


版权所有 翻版必究


目录#


同步接口#

请求参数#

请求URL:#

集群URL
北京http://api-article-bj.fengkongcloud.com/webpage/v4
弗吉尼亚http://api-article-fjny.fengkongcloud.com/webpage/v4
新加坡http://api-article-xjp.fengkongcloud.com/webpage/v4

字符编码格式:#

UTF-8字符集编码

请求方法:#

POST

建议超时时长:#

15s

请求参数:#

放在HTTP Body中,采用Json格式,Body大小不可超过3.5M,具体参数如下:

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供,用于权限认证,开通服务时由数美提供
appIdstring应用标识Y用于区分应用,需要联系数美服务开通,请使用数美单独提供的传值为准
eventIdstring事件标识Y用于区分场景数据,需要联系数美服务开通,请使用数美单独提供的传值为准
imgTypestring图片识别类型Y可选值: NONE:不审核图片 POLITY:涉政识别 EROTIC:色情&性感违规识别 VIOLENT:暴恐&违禁识别 QRCODE:二维码识别 ADVERT:广告识别 IMGTEXTRISK:图片文字违规识别(如需要识别图片里文字的违规内容,务必传入图片文字违规识别功能) BOCR:OCR小语种识别支持和语种自动检测(仅限新加坡集群) 组合说明:除NONE以外都可以通过下划线组合,如POLITY_QRCODE_ADVERT用于涉政、二维码和广告组合识别。NONE不可以和其他type拼接
txtTypestring文本识别类型Y可选值: NONE:不审核文本 POLITY:涉政检测 VIOLENT:暴恐检测 BAN:违禁检测 EROTIC:色情检测 DIRTY:辱骂检测 ADVERT:广告检测 PRIVACY:隐私检测 ADLAW:广告法检测 MEANINGLESS:无意义检测 FRUAD:网络诈骗检测 UNPOACH:高价值用户防挖检测 TEXTMINOR:未成年人内容检测 TEXTRISK:常规风险检测(包含:涉政、暴恐、违禁、色情、辱骂、广告、隐私、广告法、无意义) 组合说明:除NONE以外都可以通过下划线组合,如TEXTRISK_FRUAD。type间组合取并集,如TEXTRISK_POLITY按照常规风险检测处理。NONE不可以和其他type拼接
audioTypestring音频识别类型N可选值: NONE:不审核音频 AUDIOPOLITICAL:一号领导人声纹识别 POLITY:涉政识别 EROTIC:色情识别 ADVERT:广告识别 ADLAW:广告法识别 BAN:违禁识别 VIOLENT:暴恐识别 ANTHEN:国歌识别 MOAN:娇喘识别 DIRTY:辱骂识别 BANEDAUDIO:违禁歌曲 COPYRIGHTSONGS:版权歌曲 组合说明:如需做组合识别,通过下划线连接即可,例如POLITY_EROTIC_MOAN用于涉政、色情和娇喘识别。建议传入:POLITY_EROTIC_MOAN_ADVERTNONE不可以和其他type拼接
videoImgTypestring视频图片识别类型N可选值: NONE:不审核视频图片 POLITY:涉政识别 EROTIC:色情&性感违规识别 VIOLENT:暴恐&违禁识别 QRCODE:二维码识别 ADVERT:广告识别 IMGTEXTRISK:图片文字违规识别 组合说明:如需识别多个功能,通过下划线连接,如POLITY_QRCODE_ADVERT用于涉政、二维码和广告组合识别。NONE不可以和其他type拼接
videoAudioTypestring视频音频识别类型N可选值: NONE:不检测视频中的音频 POLITY:涉政识别 EROTIC:色情识别 ADVERT:广告识别 BAN:违禁识别 VIOLENT:暴恐识别 DIRTY:辱骂识别 ADLAW:广告法识别 MOAN:娇喘识别 AUDIOPOLITICAL:一号领导人声纹识别 ANTHEN:国歌识别 BANEDAUDIO:违禁歌曲 组合说明:如需做组合识别,通过下划线连接即可,例如POLITY_EROTIC用于涉政和色情识别。NONE不可以和其他type拼接
callbackstring回调http接口N指定回调url地址。当该字段非空时,服务将根据该字段回调通知用户审核结果(支持http/https
articleDoubleJumpConfigjson_object是否开启网页二跳审核方式N详见articleDoubleJumpConfig参数
articleScreenShotConfigjson_object是否开启网页截屏审核方式N详见articleScreenShotConfig参数
articleDynamicConfigjson_object是否开启网页动态审核方式N详见articleDynamicConfig参数
datajson_object请求的数据内容Y最长1MB, 详见data参数

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
urlstring要检测的网页链接N网址链接可下载,其中网址头部的content-type需为text/html。 内容大小500M以内,文本长度默认限制50万字,图片张数默认限制500张。(url、text、contents传且只能传其中一个)
textstring要检测的网页文本N纯文本内容审核,文本长度限制50w字。(url、text、contents传且只能传其中一个)
contentsstring要检测的网页源码N网址源码审核,文本长度默认限制50万字,图片张数默认限制500张。(url、text、contents传且只能传其中一个)
langstring待检测的文本内容语种N可选值和对应语种如下: zh:中文 en:英文 ar:阿拉伯语 hi:印地语 es:西班牙语 fr:法语 ru:俄语 pt:葡萄牙语 id:印尼语 de:德语 ja:日语 tr:土耳其语 vi:越南语 it:意大利语 th:泰语 tl:菲律宾语 ko:韩语 ms:马来语 auto:自动识别语种类型 注意:默认值为zh。国内集群客户可不传或传入zh;海外文本内容如无法确定语种,建议传入auto,系统将自动检测语种类型
acceptLangstring返回标签的语种类型N选择返回标签的语种类型 可选值: zh:中文 en:英文 不传入默认为返回中文标签
returnAllImgint返回图片的等级N可选值: 0:返回风险等级为非pass的图片 1:返回所有风险等级的图片 默认值为0
returnAllTextint返回文本的等级N可选值: 0:返回风险等级为非pass的文本 1:返回所有风险等级的文本 默认值为0
returnAllVideoImgint返回视频里的图片的等级N可选值: 0:返回风险等级为非pass的图片 1:返回所有风险等级的图片 默认值为0
returnAllVideoAudioint返回视频里的音频的等级N可选值: 0:返回风险等级为非pass的音频 1:返回所有风险等级的音频 默认值为0
returnAllVideoint返回视频的等级N可选值: 0:返回风险等级为非pass的视频 1:返回所有风险等级的视频 默认值为0
returnAllAudioint返回音频片段的等级N可选值: 0:返回风险等级为非pass的音频 1:返回所有风险等级的音频 默认值为0
tokenIdstring用户账号标识Y由数字、字母、下划线、短杠组成的长度小于等于64位的字符串。建议使用贵司用户UID(可加密)自行生成,标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值
receiveTokenIdstring私聊场景下消息接收者的用户唯一标识N由数字、字母、下划线、短杠组成的字符串,长度小于等于64位
levelint用户等级N针对不同等级的用户可配置不同拦截策略。可选值: 0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等 1:较低级用户,典型如低活跃或低等级用户等 2:中等级用户,典型如具备一定活跃或等级中等的用户等 3:较高级用户,典型如高活跃或高等级用户等 4:最高级用户,典型如付费用户、VIP用户等
genderstring用户性别N可选值: male:男性 female:女性
nicknamestring用户昵称N校验昵称内容风险
ipstringIP地址N发送该文本的用户公网IPv4或IPv6地址
deviceIdstring数美设备标识N数美设备指纹生成的设备唯一标识
dataIdstring数据标识N数据唯一标识,用于关联和追踪数据
extrajson_object辅助参数N用于辅助文本检测的相关信息,详见extra参数

其中,data 下 extra数组每个元素的内容如下:

请求参数名类型参数说明是否必传规范
roomstring直播间/游戏房间编号N传入的是直播间、聊天室等数据(eventId值为groupChat)时,开启上下文识别功能,建议传入,否则不能关联上下文
passThroughJson透传字段N该字段内容会随着返回值一起返回

其中,articleDoubleJumpConfig的内容如下:

请求参数名类型参数说明是否必传规范
isOpenbool是否开启网页二跳审核N默认不开启

其中,articleScreenShotConfig的内容如下:

请求参数名类型参数说明是否必传规范
isOpenbool是否开启网页截图审核N默认不开启
widthint截图的宽度N默认截图宽度1080
heightint截图的高度N默认截图高度6480
timeoutSecondint截图的超时时间N默认超时时间30s
userAgentstring浏览器类型N默认"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

其中,articleDynamicConfig的内容如下:

请求参数名类型参数说明是否必传规范
isOpenbool是否开启动态网页审核N默认不开启
userAgentstring浏览器类型N默认"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
cookiestring动态网页审核的cookieN默认""

同步返回结果#

说明:调用接口时会立即返回以下基础响应参数。若请求参数中传入了callback回调地址,完整的结果数据将通过回调接口异步返回。

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 9100:余额不足 9101:无权限操作
messagestring返回码描述Y和code对应: 成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存

回调返回结果#

说明:当请求参数中传入了callback回调地址时,完整的结果数据将通过回调接口异步返回。以下参数中,除code、message、requestId以外,其他必返参数仅在code返回1100时返回。

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1905:字数超限 9100:余额不足 9101:无权限操作
messagestring返回码描述Y和code对应: 成功 QPS超限 参数不合法 服务失败 字数超限 余额不足 无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
textDetailsjson_array文本风险详情Y网页中文本的风险详情,详见textDetails参数
imgDetailsjson_array图片风险详情Y网页中图片的风险详情,详见imgDetails参数
audioDetailsjson_array音频风险详情Y网页中音频的风险详情,详见audioDetails参数
videoDetailsjson_array视频风险详情Y网页中视频的风险详情,详见videoDetails参数
auxInfojson_object辅助信息Y详见auxInfo参数
resultTypeint结果类型Y当前结果类型 0:机审 1:人审
finalResultint是否为最终审核结果Y是否为最终审核结果(如仅接入机审,则默认返回1)。 0:非最终结果。说明该结果为数美风控的机审结果,还需要经过数美人审再次审核后回传贵司。 1:最终结果。贵司可直接拿返回结果进行处置、分发等下游场景的使用。

其中,textDetails的内容如下:

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败
messagestring返回码描述Y和code对应:成功、QPS超限、参数不合法、服务失败、字数超限
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
riskLabel1string一级风险标签Y一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签Y二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签Y三级风险标签,当riskLevel为PASS时为空
riskDescriptionstring风险原因Y当riskLevel为PASS时为"正常"
riskDetailjson_object风险详情Y风险详情,详见riskDetail参数
tokenLabelsjson_object账号风险画像标签信息Y账号风险画像标签信息,详见tokenLabels参数
auxInfojson_object辅助信息Y辅助信息,详见auxInfo参数
allLabelsjson_array风险标签列表Y命中的所有风险标签以及详情信息,详见allLabels参数
businessLabelsjson_array业务标签Y命中的所有业务标签以及详细信息,详见businessLabels参数
tokenProfileLabelsjson_array账号属性标签N属性账号类标签,仅在提供tokenId并开通标签服务时返回,详见账号标签参数
tokenRiskLabelsjson_array账号风险标签N风险账号类标签,仅在提供tokenId并开通标签服务时返回,详见账号标签参数
langResultjson_object语种信息N语种识别和翻译结果,详见langResult参数

其中,textDetails的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
matchedListsjson_array命中的客户自定义名单列表N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险内容片段N检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在,详见riskSegments参数

其中,textDetails的riskDetail下matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的敏感词数组N命中的敏感词数组,详见words参数

其中,matchedLists中,words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,textDetails的riskDetail下riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置

其中,allLabels的内容如下:

参数名称类型参数说明是否必返规范
riskLevelstring风险等级Y可能返回值: REVIEW:可疑 REJECT:违规
riskLabel1string一级风险标签YallLabels不为空时必返
riskLabel2string二级风险标签YallLabels不为空时必返
riskLabel3string三级风险标签YallLabels不为空时必返
riskDescriptionstring风险原因YallLabels不为空时必返
probabilityfloat置信度Y可选值在0~1之间,值越大,可信度越高。注意:allLabels不为空时必返
riskDetailjson_object映射后风险详情Y格式与上层riskDetail结构相同。注意:allLabels不为空时必返,详见riskDetail参数

其中,allLabels的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
matchedListsjson_array命中的客户自定义名单列表N命中的客户自定义名单列表,详见matchedLists参数
riskSegmentsjson_array高风险内容片段N高风险内容片段,检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在,详见riskSegments参数

其中,allLabels的riskDetail下matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的敏感词数组N命中的敏感词数组,详见words参数

其中,allLabels的riskDetail下matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,allLabels的riskDetail下riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置

其中,tokenLabels的内容如下:

参数名称类型参数说明是否必返规范
UGC_account_riskjson_objectUGC内容相关风险NUGC内容相关风险,详见UGC_account_risk参数

其中,tokenLabels的UGC_account_risk的内容如下:

参数名称类型参数说明是否必返规范
sexy_risk_tokenidfloat色情账号风险分N色情账号风险分,取值区间[0-1]

其中,textDetails的auxInfo的内容如下:

参数名称类型参数说明是否必返规范
filteredTextstring风险片段被替换为*后的文本N风险片段被替换为*后的文本
passThroughjson_object透传字段N该字段内容与请求参数data中extra的passThrough的值相同
contactResultjson_array联系方式识别结果N联系方式识别结果,包含识别出的微信、QQ、手机号的字符串类型和内容,详见contactResult参数
contextTextstring上下文文本N上下文生效时返回
unauthorizedTypestring未授权的typeN未授权的type

其中,textDetails的auxInfo的contactResult数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
contactTypeint联系方式类型N联系方式类型,可选值: 0:手机号 1:QQ号 2:微信号
contactStringstring联系方式串N联系方式串

其中,businessLabels的内容如下:

参数名称类型参数说明是否必返规范
businessLabel1string一级业务标签YbusinessLabels不为空必返
businessLabel2string二级业务标签YbusinessLabels不为空必返
businessLabel3string三级业务标签YbusinessLabels不为空必返
businessDescriptionstring标签描述YbusinessLabels不为空必返
probabilityfloat置信度Y可选值在0~1之间,值越大,可信度越高。businessLabels不为空必返
businessDetailjson_object业务详情YbusinessLabels不为空必返

其中,langResult的内容如下:

参数名称类型参数说明是否必返规范
detectedLangstring语种识别结果N当在国际化文本产品下传入lang的值为auto时返回该字段。值为标准语言代码表,例如:zhenar
translatedTextstring文本翻译结果N当传入translationTargetLang时返回该字段。值为翻译后的文本

其中,tokenProfileLabels、tokenRiskLabels的内容如下:

参数名称类型参数说明是否必返规范
label1string一级标签N
label2string二级标签N
label3string三级标签N
descriptionstring标签描述N
timestampint打标签时间戳N13位Unix时间戳,单位:毫秒

其中,imgDetails的内容如下:

参数名称类型参数说明是否必返规范
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
messagestring返回码描述Y和code对应:成功、QPS超限、参数不合法、服务失败、字数超限
codeint返回码Y1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1911:图片下载失败
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
riskLabel1string一级风险标签Y一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签Y二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签Y三级风险标签,当riskLevel为PASS时为空
riskDescriptionstring风险原因Y当riskLevel为PASS时为"正常"
resultTypeint当前结果是机审还是人审环节结果Y可选值: 0:机审 1:人审
finalResultint是否最终结果Y可选值: 0:不是最终结果,该结果为数美风控的过程结果,还需要经过数美人审再次check后回传 1:最终结果,可直接拿返回结果进行处置、分发等下游场景的使用
auxInfojson_object辅助信息Y辅助信息,详见auxInfo参数
allLabelsjson_array风险标签列表Y命中的所有风险标签以及详情信息,详见allLabels参数
businessLabelsjson_array业务标签N命中的所有业务标签以及详细信息,详见businessLabels参数
riskDetailjson_object风险详情Y风险详情,详见riskDetail参数
disposaljson_object处置和映射结果N数美可按照贵司的标签体系和标识进行返回;未配置自定义标签体系则不返回该字段,详见disposal参数
tokenLabelsjson_object账号风险画像标签信息Y账号风险画像标签信息,仅在提供tokenId并联系数美开通时返回,详见tokenLabels参数
tokenProfileLabelsjson_array辅助信息N属性账号类标签,仅在提供tokenId并开通标签服务时返回。详见账号标签参数
tokenRiskLabelsjson_array辅助信息N风险账号类标签,仅在提供tokenId并开通标签服务时返回。详见账号标签参数

其中,imgDetails的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint人脸数量N人脸数量
person_numint人像数量N人像数量
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
ocrTextjson_object返回图片中文字识别内容N当请求参数imgType字段包含IMGTEXTRISKADVERT时存在,详见ocrText参数
personsjson_array图片中人物的名称及位置信息N仅当命中人像-多人时,数组元素会有多个,最多10个,详见persons参数

其中,imgDetails的riskDetail下faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring人物编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N能识别的公众人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的riskDetail下objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring二维码地址N仅当命中二维码相关标签时返回
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的riskDetail下persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring人物编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,imgDetails的riskDetail下ocrText的内容如下:

参数名称类型参数说明是否必返规范
textstring图片中识别出的文字Y图片中识别出的文字
matchedListsjson_array命中的客户自定义名单列表N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、广告法等风险内容的时候存在,详见riskSegments参数

其中,imgDetails的riskDetail下ocrText的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的敏感词信息N命中的这个名单中的敏感词信息,详见words参数

其中,imgDetails的riskDetail下ocrText的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,imgDetails的riskDetail下ocrText的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,imgDetails的auxInfo的内容如下:

参数名称类型参数说明是否必返规范
segmentsint实际处理的片段数Y实际处理的片段数
typeVersionjson_object模型版本号Y对应传入type值的模型版本号,详见typeVersion参数
errorCodeint错误码N可选值: 2001:输入数据格式不正确,不是有效的JSON数据 2002:输入参数字段非法(缺少必填字段、类型错误、取值非法等) 2003:图片下载失败 2004:图片过大,超过10M 2005:非法图片格式 2006:非法风险监控类型
frameTimeint截帧时间戳N当请求参数传入streamInfo功能时返回相似功能。13位毫秒级时间戳
qrContentstring二维码地址N返回图片中识别的二维码地址
streamIdstring流标识N请求参数中包含streamInfo等参数,传入后会返回相似功能
passThroughjson_object透传字段N客户传入的透传字段。数美内部不会识别处理该字段,随结果返回给用户

其中,imgDetails的auxInfo的typeVersion的内容如下:

参数名称类型参数说明是否必返规范
ADVERTstring广告版本号N格式为X.Y,其中X表示主版本号,通常表示模型整体效果迭代;Y表示次版本号,通常表示日常例行迭代。例如1001001.2表示主版本号为1001001,次版本号为2
EROTICstring色情版本号N格式为X.Y,其中X表示主版本号,通常表示模型整体效果迭代;Y表示次版本号,通常表示日常例行迭代。例如1001001.2表示主版本号为1001001,次版本号为2
IMGTEXTRISKstring图片文字违规版本号N格式为X.Y,其中X表示主版本号,通常表示模型整体效果迭代;Y表示次版本号,通常表示日常例行迭代。例如1001001.2表示主版本号为1001001,次版本号为2
POLITYstring涉政版本号N格式为X.Y,其中X表示主版本号,通常表示模型整体效果迭代;Y表示次版本号,通常表示日常例行迭代。例如1001001.2表示主版本号为1001001,次版本号为2
QRCODEstring二维码版本号N格式为X.Y,其中X表示主版本号,通常表示模型整体效果迭代;Y表示次版本号,通常表示日常例行迭代。例如1001001.2表示主版本号为1001001,次版本号为2
VIOLENTstring暴恐版本号N格式为X.Y,其中X表示主版本号,通常表示模型整体效果迭代;Y表示次版本号,通常表示日常例行迭代。例如1001001.2表示主版本号为1001001,次版本号为2

其中,imgDetails的allLabels的内容如下:

参数名称类型参数说明是否必返规范
riskLevelstring风险等级Y可能返回值: REVIEW:可疑 REJECT:违规
riskLabel1string一级风险标签YallLabels不为空时必返
riskLabel2string二级风险标签YallLabels不为空时必返
riskLabel3string三级风险标签YallLabels不为空时必返
riskDescriptionstring风险原因YallLabels不为空时必返。当riskLevel为PASS时返回正常;其他情况展现形式为:"一级标签:二级标签:三级标签"的中文名。仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高。注意:allLabels不为空时必返
riskDetailjson_object映射后风险详情Y格式与imgDetails的riskDetail结构相同。注意:allLabels不为空时必返,详见riskDetail参数

其中,imgDetails的allLabels的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint人脸数量N人脸数量
person_numint人像数量N人像数量
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
ocrTextjson_object返回图片中文字识别内容N当请求参数imgType字段包含IMGTEXTRISK或ADVERT时存在,详见ocrText参数
personsjson_array图片中人物的名称及位置信息N当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见persons参数

其中,imgDetails的allLabels的riskDetail的faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的allLabels的riskDetail的objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring返回图片中识别的二维码地址N返回图片中识别的二维码地址
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的allLabels的riskDetail的ocrText的内容如下:

参数名称类型参数说明是否必返规范
textstring图片中识别出的文字Y图片中识别出的文字
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在,详见riskSegments参数

其中,imgDetails的allLabels的riskDetail的ocrText的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,imgDetails的allLabels的riskDetail的ocrText的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,imgDetails的allLabels的riskDetail的ocrText的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,imgDetails的allLabels的riskDetail的persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,imgDetails的businessLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
businessDescriptionstring业务标签描述Y格式为"一级标签:二级标签:三级标签"的中文名称
businessLabel1string一级业务标签Y一级业务标签
businessLabel2string二级业务标签Y二级业务标签
businessLabel3string三级业务标签Y三级业务标签
probabilityfloat置信度Y可选值在0~1之间,值越大,可信度越高
confidenceLevelint置信等级N可选值在0~2之间,值越大,可信度越高
businessDetailjson_object业务标签详情N详见businessDetail参数

其中,imgDetails的businessLabels的businessDetail的内容如下:

参数名称类型参数说明是否必返规范
face_compare_numint人脸对比数量N当传入FACECOMPARE业务类型和imgCompareBase时存在。imgCompareBase检测传入图片中的人脸数量
face_numint人脸数量N人脸数量
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
namestring人物名称N人物名称
person_numint人像数量N人像数量
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
locationint_array位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
personsjson_array图片中人物的名称及位置信息N当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见persons参数

其中,imgDetails的businessLabels的businessDetail的faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的businessLabels的businessDetail的objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring返回图片中识别的二维码地址N返回图片中识别的二维码地址
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的businessLabels的businessDetail的persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,imgDetails的disposal的内容如下:

参数名称类型参数说明是否必返规范
riskDescriptionstring映射后风险原因Y当riskLevel为PASS时为正常
riskLabel1string映射后一级风险标签Y一级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel1值为normal
riskLabel2string映射后二级风险标签Y二级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel2值为空
riskLabel3string映射后三级风险标签Y三级风险标签,当数美标签未映射上自定义标签,且disposal下的riskLevel为PASS时,riskLabel3值为空
riskLevelstring处置建议Y若贵司有自己的处置规则,数美可按照贵司的处置逻辑配置并返回对应的处置建议;若规则标签未映射上,则返回默认处置建议
riskDetailjson_object映射后风险详情Y格式与imgDetails的riskDetail结构相同,详见riskDetail参数

其中,imgDetails的disposal的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint人脸数量N人脸数量
person_numint人像数量N人像数量
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
ocrTextjson_object返回图片中文字识别内容N当请求参数imgType字段包含IMGTEXTRISK或ADVERT时存在,详见ocrText参数
personsjson_array图片中人物的名称及位置信息N当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见persons参数

其中,imgDetails的disposal的riskDetail的faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的disposal的riskDetail的objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring返回图片中识别的二维码地址N返回图片中识别的二维码地址
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,imgDetails的disposal的riskDetail的ocrText的内容如下:

参数名称类型参数说明是否必返规范
textstring图片中识别出的文字Y图片中识别出的文字
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在,详见riskSegments参数

其中,imgDetails的disposal的riskDetail的ocrText的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,imgDetails的disposal的riskDetail的ocrText的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,imgDetails的disposal的riskDetail的ocrText的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,imgDetails的disposal的riskDetail的persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,imgDetails的tokenLabels的内容如下:

参数名称类型参数说明是否必返规范
UGC_account_riskjson_objectUGC内容相关风险NUGC内容相关风险,详见UGC_account_risk参数
machine_account_riskjson_object机器控制相关风险N机器控制相关风险,详见machine_account_risk参数
scene_account_riskjson_object场景账号风险N场景账号风险,仅在特殊场景下可获得,如航空公司等,详见scene_account_risk参数

其中,imgDetails的tokenLabels的UGC_account_risk的内容如下:

参数名称类型参数说明是否必返规范
b_advertise_risk_tokenidint广告风险N可选值: 0:当前未检测到广告风险 1:存在广告风险
b_advertise_risk_tokenid_last_tsint广告风险时间N广告风险时间戳
b_politics_risk_tokenidint涉政风险N可选值: 0:当前未识别到涉政风险 1:存在涉政风险
b_politics_risk_tokenid_last_tsint涉政风险时间N涉政风险时间戳
b_sexy_risk_tokenidint色情风险N可选值: 0:当前暂时未检测到色情风险 1:存在色情风险
b_sexy_risk_tokenid_last_tsint色情风险时间N色情风险时间戳

其中,imgDetails的tokenLabels的machine_account_risk的内容如下:

参数名称类型参数说明是否必返规范
b_machine_control_tokenidint机器账号N可选值: 0:非机器控制账号 1:机器控制账号
b_machine_control_tokenid_last_tsint机器账号时间N机器账号时间戳
b_offer_wall_tokenidint积分墙账号N可选值: 0:非积分墙账号 1:积分墙账号
b_offer_wall_tokenid_last_tsint积分墙账号时间N积分墙账号时间戳

其中,imgDetails的tokenLabels的scene_account_risk的内容如下:

参数名称类型参数说明是否必返规范
i_tout_risk_tokenidint航空公司占座账号N可选值: 0:非航空公司占座账号 1:航空公司占座账号
i_tout_risk_tokenid_last_tsint航空公司占座时间N航空公司占座时间戳

其中,audioDetails的内容如下:

参数名称类型参数说明是否必返规范
requestIdstring请求标识Y本次请求的唯一标识,用于问题排查和效果优化,强烈建议保存
codeint返回码Y1100:成功 1101:正在处理中 1901:QPS超限 1902:参数不合法 1903:服务失败 1904:下载失败 1905:解码失败 除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述Y和code对应:成功、正在处理中、QPS超限、参数不合法、服务失败、下载失败、解码失败、余额不足、无权限操作
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截 建议:对接初期不直接使用结果,进行拦截尺度调优,符合预期后再进行使用
audioTextstring整段音频转译文本结果Y整段音频转译文本结果
audioTimeint整段音频的音频时长Y单位秒
audioDetailjson_array音频片段信息Y回调的音频片段信息,详见audioDetail参数

其中,audioDetail具体参数如下:

参数名称类型参数说明是否必返规范
requestIdstring请求标识Y音频片段请求唯一标识
audioStarttimefloat音频片段起始时间Y相对音频开始的时间距离,单位是秒
audioEndtimefloat音频片段结束时间Y相对音频开始的时间距离,单位是秒
audioUrlstring音频片段链接Ymp3格式
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
businessLabelsjson_array业务标签N命中的所有业务标签以及详细信息,详见businessLabels参数
allLabelsjson_array风险标签列表N命中的所有风险标签以及详情信息,详见allLabels参数
riskLabel1string一级风险标签Y一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签Y二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签Y三级风险标签,当riskLevel为PASS时为空
riskDescriptionstring风险原因Y当riskLevel为PASS时为"正常"
riskDetailjson_object风险详情N风险详情,详见riskDetail参数

其中,audioDetail的businessLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
businessLabel1string一级业务标签Y一级业务标签
businessLabel2string二级业务标签Y二级业务标签
businessLabel3string三级业务标签Y三级业务标签
businessDescriptionstring业务标签描述Y格式为"一级标签:二级标签:三级标签"的中文名称
confidenceLevelint置信等级N可选值在0~2之间,值越大,可信度越高
probabilityfloat置信度Y可选值为0~1,值越大,可信度越高
businessDetailjson_object业务标签详情N保留字段

其中,audioDetail的allLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
riskLevelstring风险等级Y可能返回值: REVIEW:可疑 REJECT:违规
riskLabel1string一级风险标签YallLabels不为空时必返
riskLabel2string二级风险标签YallLabels不为空时必返
riskLabel3string三级风险标签YallLabels不为空时必返
riskDescriptionstring风险原因YallLabels不为空时必返。当riskLevel为PASS时返回正常;其他情况展现形式为:"一级标签:二级标签:三级标签"的中文名。仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
probabilityfloat置信度N可选值在0~1之间,值越大,风险可能性越高,值越小,无风险可能性越高。注意:allLabels不为空时必返
riskDetailjson_object映射后风险详情Y格式与audioDetail的riskDetail结构相同。注意:allLabels不为空时必返,详见riskDetail参数

其中,audioDetail的allLabels的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring音频转译文本的结果N音频转译文本的结果
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险内容片段N详见riskSegments参数

其中,audioDetail的allLabels的riskDetail的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring客户自定义名单名称Y客户自定义名单名称
wordsjson_array命中的这个名单中的敏感词信息Y详见words参数

其中,audioDetail的allLabels的riskDetail的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring敏感词Y敏感词
positionint_array敏感词所在位置Y敏感词所在位置

其中,audioDetail的allLabels的riskDetail的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置

其中,audioDetail的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring音频转译文本的结果N音频转译文本的结果
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险内容片段N详见riskSegments参数

其中,audioDetail的riskDetail的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring客户自定义名单名称Y客户自定义名单名称
wordsjson_array命中的这个名单中的敏感词信息Y详见words参数

其中,audioDetail的riskDetail的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring敏感词Y敏感词
positionint_array敏感词所在位置Y敏感词所在位置

其中,audioDetail的riskDetail的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置

其中,videoDetails具体参数如下:

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功 1901:QPS超限 1902:参数不合法 1903:服务失败 1905:字数超限
messagestring返回码描述Y和code对应:成功、QPS超限、参数不合法、服务失败、字数超限、无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
frameDetailjson_array风险详情N有风险片段或returnAllVideoImg=1时返回,详见frameDetail说明
audioDetailjson_array音频片段信息N有风险片段或returnAllVideoAudio=1时返回,详见audioDetail说明
auxInfojson_object辅助信息Ncode为1100时存在,详见auxInfo说明
tokenProfileLabelsjson_array账号属性标签N仅在开启功能时返回,详见tokenProfileLabels说明
tokenRiskLabelsjson_array账号风险标签N仅在开启功能时返回,详见tokenProfileLabels说明

其中,frameDetail具体参数如下:

参数名称类型参数说明是否必返规范
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
imgUrlstring截帧图片地址Y截帧图片地址
riskDescriptionstring风险描述Y当riskLevel为PASS时返回:正常。格式为:"一级风险标签:二级风险标签:三级风险标签",的中文名称。对于命中用户自定义名单时返回:命中自定义名单。
riskLabel1string一级风险标签Y一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签Y二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签Y三级风险标签,当riskLevel为PASS时为空
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
allLabelsjson_array风险标签列表Y命中的所有风险标签以及详情信息,详见allLabels参数
auxInfojson_object辅助信息Y辅助信息,详见auxInfo参数
riskDetailjson_object风险详情Y风险详情,详见riskDetail参数
imgTextstring截帧图片OCR文本内容N截帧图片OCR文字识别,仅传入ADVERT、IMGTEXTRISK时返回
timefloat截帧在视频文件中的时间N截帧图片相对视频文件的时间,单位为秒
businessLabelsjson_array业务标签N命中的所有业务标签以及详细信息,详见businessLabels参数

其中,frameDetail的allLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
riskLevelstring风险等级Y可能返回值: REVIEW:可疑 REJECT:违规
riskLabel1string一级风险标签YallLabels不为空时必返
riskLabel2string二级风险标签YallLabels不为空时必返
riskLabel3string三级风险标签YallLabels不为空时必返
riskDescriptionstring风险原因YallLabels不为空时必返。当riskLevel为PASS时返回正常;其他情况展现形式为:"一级标签:二级标签:三级标签"的中文名。仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高。注意:allLabels不为空时必返
riskDetailjson_object映射后风险详情Y格式与frameDetail的riskDetail结构相同。注意:allLabels不为空时必返,详见riskDetail参数

其中,frameDetail的allLabels的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint人脸数量N人脸数量
person_numint人像数量N人像数量
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
ocrTextjson_object返回图片中文字识别内容N当请求参数imgType字段包含IMGTEXTRISK或ADVERT时存在,详见ocrText参数
personsjson_array图片中人物的名称及位置信息N当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见persons参数

其中,frameDetail的allLabels的riskDetail的faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring人物编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N能识别的公众人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,frameDetail的allLabels的riskDetail的objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring二维码地址N仅当命中二维码相关标签时返回
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,frameDetail的allLabels的riskDetail的ocrText的内容如下:

参数名称类型参数说明是否必返规范
textstring图片中识别出的文字Y图片中识别出的文字
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在,详见riskSegments参数

其中,frameDetail的allLabels的riskDetail的ocrText的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,frameDetail的allLabels的riskDetail的ocrText的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,frameDetail的allLabels的riskDetail的ocrText的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,frameDetail的allLabels的riskDetail的persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring人物编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,frameDetail的auxInfo的内容如下:

参数名称类型参数说明是否必返规范
similarityfloat相似度Y返回当前截帧图片和上一帧截帧图片的相似度。视频文件初始第一帧将比对纯黑背景图片。与上一张截帧图片的相似概率值,取值范围[0-1],数值越接近1越相似
qrContentstring二维码地址N返回图片中识别的二维码地址

其中,frameDetail的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1002:视觉图片风险
face_numint人脸数量N人脸数量
person_numint人像数量N人像数量
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
ocrTextjson_object返回图片中文字识别内容N当请求参数imgType字段包含IMGTEXTRISK或ADVERT时存在,详见ocrText参数
personsjson_array图片中人物的名称及位置信息N当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见persons参数

其中,frameDetail的riskDetail的faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring人物编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N能识别的公众人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,frameDetail的riskDetail的objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring二维码地址N仅当命中二维码相关标签时返回
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,frameDetail的riskDetail的ocrText的内容如下:

参数名称类型参数说明是否必返规范
textstring图片中识别出的文字Y图片中识别出的文字
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在,详见riskSegments参数

其中,frameDetail的riskDetail的ocrText的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring命中的名单名称N命中的名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,frameDetail的riskDetail的ocrText的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置

其中,frameDetail的riskDetail的ocrText的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,frameDetail的riskDetail的persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring人物编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,frameDetail的businessLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
businessDescriptionstring业务标签描述Y格式为"一级标签:二级标签:三级标签"的中文名称
businessLabel1string一级业务标签Y一级业务标签
businessLabel2string二级业务标签Y二级业务标签
businessLabel3string三级业务标签Y三级业务标签
probabilityfloat置信度Y可选值在0~1之间,值越大,可信度越高
confidenceLevelint置信等级N可选值在0~2之间,值越大,可信度越高
businessDetailjson_object业务标签详情N详见businessDetail参数

其中,frameDetail的businessLabels的businessDetail的内容如下:

参数名称类型参数说明是否必返规范
face_numint人脸数量N人脸数量
person_numint人像数量N人像数量
facesjson_array图片中涉政人物的名称及位置信息N当命中人脸-人脸类型-多人脸时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见faces参数
objectsjson_array物品信息N返回图片中标识或物品的名称及位置信息,详见objects参数
personsjson_array图片中人物的名称及位置信息N当命中'人像-多人'标签时,数组元素会有多个,最多10(如果超过10个,选择probability最高的10个),详见persons参数

其中,frameDetail的businessLabels的businessDetail的faces数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
face_ratiofloat人脸占比N在区间0-1,数值越大,人脸占比越高
idstring人物编号N图片同一个位置下的人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
namestring人物名称N能识别的公众人物名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人物位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,frameDetail的businessLabels的businessDetail的objects数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring物品或标识编号N保证同一个位置下的物品在不同标签下的编号相同
namestring物品名称N物品名称
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
qrContentstring二维码地址N仅当命中二维码相关标签时返回
locationint_array物品位置信息N该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标

其中,frameDetail的businessLabels的businessDetail的persons数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
idstring人物编号N保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次,分配n个ID
person_ratiofloat人像占比N在区间0-1,数值越大,人脸占比越高
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高
locationint_array人像位置坐标N人像位置坐标

其中,videoDetails的audioDetail具体参数如下:

参数名称类型参数说明是否必返规范
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
audioUrlstring音频片段地址Y音频片段地址
riskDescriptionstring风险描述Y当riskLevel为PASS时返回:正常。格式为:"一级风险标签:二级风险标签:三级风险标签",的中文名称。对于命中用户自定义名单时返回:命中自定义名单。
riskLabel1string一级风险标签Y一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签Y二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签Y三级风险标签,当riskLevel为PASS时为空
riskLevelstring处置建议Y可能返回值: PASS:正常,建议直接放行 REVIEW:可疑,建议人工审核 REJECT:违规,建议直接拦截
allLabelsjson_array风险标签列表Y命中的所有风险标签以及详情信息,详见allLabels参数
audioEndtimefloat音频片段结束时间N相对音频开始时间的距离,单位是秒
audioStarttimefloat音频片段开始时间N相对音频开始时间的距离,单位是秒
audioTextstring该片段识别的文字内容N该片段识别的文字内容
businessLabelsjson_array业务标签N命中的所有业务标签以及详细信息,详见businessLabels参数
riskDetailjson_object风险详情N风险详情,详见riskDetail参数

其中,videoDetails的audioDetail的allLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
riskLevelstring风险等级Y可能返回值: REVIEW:可疑 REJECT:违规
riskLabel1string一级风险标签YallLabels不为空时必返
riskLabel2string二级风险标签YallLabels不为空时必返
riskLabel3string三级风险标签YallLabels不为空时必返
riskDescriptionstring风险原因YallLabels不为空时必返。当riskLevel为PASS时返回正常;其他情况展现形式为:"一级标签:二级标签:三级标签"的中文名。仅供人了解风险原因时作为参考,程序请勿依赖该参数的值做逻辑处理
probabilityfloat置信度N可选值在0~1之间,值越大,可信度越高。注意:allLabels不为空时必返
riskDetailjson_object映射后风险详情Y格式与videoDetails的audioDetail的riskDetail结构相同。注意:allLabels不为空时必返,详见riskDetail参数

其中,videoDetails的audioDetail的allLabels的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring该片段识别的文字内容N该片段识别的文字内容
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在,详见riskSegments参数

其中,videoDetails的audioDetail的allLabels的riskDetail的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring名单名称N名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,videoDetails的audioDetail的allLabels的riskDetail的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置,下标从0开始计数

其中,videoDetails的audioDetail的allLabels的riskDetail的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,videoDetails的audioDetail的businessLabels数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
businessDescriptionstring业务标签描述Y格式为"一级标签:二级标签:三级标签"的中文名称
businessLabel1string一级业务标签Y一级业务标签
businessLabel2string二级业务标签Y二级业务标签
businessLabel3string三级业务标签Y三级业务标签
probabilityfloat置信度Y可选值在0~1之间,值越大,可信度越高
confidenceLevelint置信等级N可选值在0~2之间,值越大,可信度越高
businessDetailjson_object业务标签详情N详见businessDetail参数

其中,videoDetails的audioDetail的businessLabels的businessDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring该片段识别的文字内容N该片段识别的文字内容
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测音频包含未成年,唱歌等风险内容的时候存在,详见riskSegments参数

其中,videoDetails的audioDetail的businessLabels的businessDetail的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring名单名称N名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,videoDetails的audioDetail的businessLabels的businessDetail的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置,下标从0开始计数

其中,videoDetails的audioDetail的businessLabels的businessDetail的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,videoDetails的audioDetail的riskDetail的内容如下:

参数名称类型参数说明是否必返规范
riskSourceint风险来源Y可能取值: 1000:无风险 1001:文字风险 1003:音频语音风险
audioTextstring该片段识别的文字内容N该片段识别的文字内容
matchedListsjson_array命中的客户自定义名单信息N仅在命中客户自定义名单时返回,详见matchedLists参数
riskSegmentsjson_array高风险片段内容N检测图片包含涉政、暴恐、违禁、竞品、广告法等风险内容的时候存在,详见riskSegments参数

其中,videoDetails的audioDetail的riskDetail的matchedLists数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
namestring名单名称N名单名称
wordsjson_array命中的这个名单中的敏感词信息N详见words参数

其中,videoDetails的audioDetail的riskDetail的matchedLists的words数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
wordstring命中的敏感词N命中的敏感词
positionint_array敏感词所在位置N敏感词所在位置,下标从0开始计数

其中,videoDetails的audioDetail的riskDetail的riskSegments数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
segmentstring高风险内容片段N高风险内容片段
positionint_array高风险内容片段所在位置N高风险内容片段所在位置,下标从0开始计数

其中,videoDetails的auxInfo具体参数如下:

参数名称类型参数说明是否必返规范
audioDurationfloat当前请求中的视频里的音频时长Y单位是秒,与计费数目一致。审核视频时,如果视频文件中音轨数据和视频时长不一致,计费时长以实际的音轨时长为准;例如可能会存在没有音轨的情况,计费时长就为0
frameCountint返回的视频截帧数量YreturnAllImg=0时为风险数量,returnAllImg=1时为全部数量
videoDurationfloat视频时长Y单位是秒

其中,auxInfo的内容如下:

参数名称类型参数说明是否必返规范
textNumint当前请求中的字符数Y当前请求中的字符数,与计费数目一致。字符数包括汉字、英文、标点符号、空格等
imgNumint当前请求中的图片数Y当前请求中的图片数,与计费数目一致。如遇动图会截取3帧;如遇长图会进行切分
audioNumint当前请求中的音频数Y当前请求中的音频数,与计费数目一致
videoNumint当前请求中的视频数Y当前请求中的视频数,与计费数目一致
passThroughjson_object透传字段N客户传入的透传字段,数美内部不会对该字段进行识别处理,会随结果原样返回给用户

示例#

回调模式示例#

请求示例#
{
"accessKey": "your_access_key",
"appId": "your_app_id",
"eventId": "webpage",
"imgType": "POLITY_EROTIC_ADVERT",
"txtType": "TEXTRISK",
"audioType": "POLITY_EROTIC_ADVERT",
"videoImgType": "POLITY_EROTIC_ADVERT",
"videoAudioType": "POLITY_EROTIC_ADVERT",
"callback": "http://www.xxx.top/callbackaddr",
"articleDoubleJumpConfig": {
"isOpen": true
},
"articleScreenShotConfig": {
"isOpen": true,
"width": 1080,
"height": 6480,
"timeoutSecond": 30,
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
},
"articleDynamicConfig": {
"isOpen": true,
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
"cookie": ""
},
"data": {
"url": "https://www.example.com/page",
"tokenId": "user_123456",
"lang": "zh",
"acceptLang": "zh",
"returnAllImg": 0,
"returnAllText": 0,
"returnAllVideoImg": 0,
"returnAllVideoAudio": 0,
"returnAllVideo": 0,
"returnAllAudio": 0,
"level": 2,
"gender": "male",
"nickname": "test_user",
"ip": "123.171.34.3",
"deviceId": "device_fingerprint_123",
"dataId": "data_unique_id_001",
"extra": {
"room": "room_001",
"passThrough": {
"customField": "customValue"
}
}
}
}
同步返回示例#
{
"code":1100,
"message":"success",
"requestId":"xxx"
}
回调返回示例#
{
"code": 1100,
"message": "success",
"requestId": "xxx",
"riskLevel": "REVIEW",
"textDetails": [
{
"allLabels": [
{
"probability": 1,
"riskDescription": "涉政:涉政:涉政",
"riskDetail": {
"matchedLists": [
{
"name": "测试zyk",
"words": [
{
"position": [
10,
11
],
"word": "58"
}
]
}
]
},
"riskLabel1": "politics",
"riskLabel2": "politics",
"riskLabel3": "politics",
"riskLevel": "REVIEW"
},
{
"probability": 1,
"riskDescription": "涉政:涉政:涉政",
"riskDetail": {
"matchedLists": [
{
"name": "测试zyk",
"words": [
{
"position": [
10,
11,
12
],
"word": "585"
}
]
}
]
},
"riskLabel1": "politics",
"riskLabel2": "shezheng",
"riskLabel3": "shezheng",
"riskLevel": "REVIEW"
}
],
"requestId": "rerlgiewregliweruogrerwd_1",
"riskDescription": "涉政:涉政:涉政",
"riskDetail": {
"matchedLists": [
{
"name": "测试zyk",
"words": [
{
"position": [
10,
11,
12
],
"word": "585"
}
]
}
]
},
"riskLabel1": "politics",
"riskLabel2": "shezheng",
"riskLabel3": "shezheng"
}
],
"imgDetails": [
],
"auxInfo": {
"imgCount": 4,
"textCount": 317
}
}

结果查询接口#

用于异步队列、callback 回调或音视频分段回调等场景下,按检测接口返回的 requestId 主动查询终态审核结果(业务字段与上文回调返回结果一致)。

请求参数#

请求URL:#

集群URL
北京http://api-article-bj.fengkongcloud.com/query_webpage/v4
弗吉尼亚http://api-article-fjny.fengkongcloud.com/query_webpage/v4
新加坡http://api-article-xjp.fengkongcloud.com/query_webpage/v4

字符编码格式:#

UTF-8字符集编码

请求方法:#

POST

建议超时时长:#

15s

请求参数:#

放在HTTP Body中,采用Json格式,Body大小不可超过1M,具体参数如下:

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y与检测接口一致,由数美提供
requestIdsstring_array待查询的检测请求标识列表Y传入网页检测接口同步返回体中的 requestId;单次最多20条,单条长度不超过128字符;重复项会去重

同步返回结果#

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功;1902:整单请求不合法。11011903 不出现在本字段,仅见于下文 machineResult.code
messagestring返回码描述Y与 code 对应
requestIdstring请求标识Y本次查询请求的标识
contentsjson_array查询结果列表Y与请求 requestIds 顺序一致,元素结构见下表

其中,contents 数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
requestIdstring检测请求标识Y对应某项待查 requestId
machineResultjson_object机审结果Y单项 code(与顶层 code 独立):1100 终态成功,业务字段同上文回调返回结果1101 无历史记录或仍在处理(message 为「请求正在处理」);1902 历史表 data 无法解析为合法 JSON;1903 历史结果因数据过长写入降级记录(message 为「服务失败」,含 detail 等)。
humanResultjson_object人审结果N有人审时返回
mergeResultjson_object合并结果N优先展示策略合并结果,例如 riskLevel

示例#

请求示例#

{
"accessKey": "your_access_key",
"requestIds": ["xxx_detection_request_id"]
}

返回示例#

处理中(machineResult.code 为 1101)#
{
"code": 1100,
"message": "正常",
"requestId": "query_req_001",
"contents": [
{
"requestId": "xxx_detection_request_id",
"machineResult": {
"code": 1101,
"message": "请求正在处理",
"requestId": "xxx_detection_request_id"
},
"mergeResult": {
"riskLevel": "xxx"
}
}
]
}
终态成功(machineResult.code 为 1100)#
{
"code": 1100,
"message": "正常",
"requestId": "query_req_001",
"contents": [
{
"requestId": "xxx_detection_request_id",
"machineResult": {
"code": 1100,
"message": "成功",
"requestId": "xxx_detection_request_id",
"riskLevel": "xxx",
"textDetails": [],
"imgDetails": [],
"audioDetails": [],
"videoDetails": [],
"auxInfo": {},
"resultType": 0,
"finalResult": 1
},
"mergeResult": {
"riskLevel": "xxx"
}
}
]
}

在线咨询