轮询模式
内容安全直播视频异步检测或人工审核的结果,客户可以通过轮询调用该接口获取数据。轮询模式与推送模式互斥,只能选取一种模式进行结果获取。
接口说明
该接口返回直播视频经过机器检测或者人工审核的结果,需要客户通过该接口进行定时轮询获取,当提交检测接口参数callbackUrl为空时,表示结果通过该接口获取,结果可以根据提交检测时返回的taskId对应。
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权
结果说明
- 获取结果后,下次调用,不会再次返回之前获取过的结果
- 接口一次最多返回200个结果,审核结果数据默认保留7天,7天不获取会失效
- 接口请求频率建议1s一次,过快服务器会拒绝处理,客户可以根据业务需求进行适当调整
接口耗时
结果获取接口的响应很快,正常50ms内返回结果,业务方根据需求适当调整超时时间,建议为1s
历史版本
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | http://as.dun.163.com/v4/livevideo/callback/results |
HTTP Method | POST |
请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | String | 是 | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数
业务参数
名称 | 类型 | 必填 | 最大长度 | 描述 |
---|---|---|---|---|
version | String | 是 | 4 | 接口版本v4 |
yidunRequestId | String | 否 | 64 | 幂等参数说明 |
请求体示例
version=v4&signature=xxx&secretId=xxx&businessId=xxx
响应
该接口可以返回人工审核结果或异步机器检测结果,两类结果结构保持一致
响应结果
响应字段如下,响应公共字段已省略,详细见响应公共字段,详细字段信息如下:
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
result | Object[] | 是 | 视频检测结果 |
∟ antispam | Object | 否 | 内容安全检测结果 |
∟ taskId | String | 是 | 检测任务 ID,示例值:"38e08da8d2574df4bd2eca9b5153df72" |
∟ callback | String | 否 | 提交时传递的callback |
∟ dataId | String | 否 | 提交时传递的dataId |
∟ censorSource | Number | 是 | 审核来源,0:易盾人审,1:客户人审,2:易盾机审 |
∟ status | Number | 是 | 检测状态,1-检测中,2-检测成功,3-检测失败 |
∟ failureReason | Number | 否 | 检测失败原因,当检测失败时返回,1:下载失败,2:直播流不存在,3:解析失败,4:格式错误 |
∟ riskLevel | Number | 否 | 直播异常风险等级, 0-正常,1-低危,2-中危,3-中高危,4-高危 |
∟ riskScore | Number | 否 | 直播异常分数 |
∟ duration | Number | 否 | 直播时长字段,直播结束返回直播整体时长,单位s |
∟ evidences | Object | 否 | 直播截图审核证据信息 |
∟ evidence | Object | 否 | 证据信息 |
∟ suggestion | Number | 是 | 建议结果 0-通过 1-嫌疑 2-删除 |
∟ suggestionLevel | Number | 否 | 只有在嫌疑时才可能返回,嫌疑程度:1:低嫌疑,2:高嫌疑 |
∟ type | Number | 是 | 证据信息类型,1-图片,2-视频 |
∟ url | String | 是 | 证据信息内容 |
∟ beginTime | Number | 是 | 直播当前时间点,单位为毫秒 |
∟ endTime | Number | 是 | 直播当前时间点,单位为毫秒 |
∟ speakerId | String | 否 | 针对接入SDK监听客户,返回说话人ID信息 |
∟ frontPics | Object[] | 否 | 关联信息-命中前截图信息 |
∟ url | String | 是 | 命中前截图信息 |
∟ labels | Object[] | 否 | 分类信息 |
∟ label | Number | 是 | 分类信息,100:色情,110:性感低俗,200:广告,210:二维码,260:广告法,300:暴恐,400:违禁,500:涉政,800:恶心类,900:其他,1020:黑屏,1030:挂机,1100:涉价值观 |
∟ level | Number | 是 | 分类级别,0:正常,1:不确定,2:确定 |
∟ rate | Number | 是 | 置信度分数,0-1之间取值,1为置信度最高,0为置信度最低。若level为正常,置信度越大,说明正常的可能性越高。若level为不确定或确定,置信度越大,说明垃圾的可能性越高 |
∟ subLabels | Object[] | 是 | 细分类信息,可能包含多个 |
∟ subLabel | String | 是 | 细分类,详细编码请参考下方对应细分类编码对照表 |
∟ rate | Number | 是 | 置信度分数,0-1之间取值,1为置信度最高,0为置信度最低 |
∟ details | Object | 否 | 命中的详细对象信息 |
∟ keywords | Object[] | 否 | 命中的自定义敏感词信息 |
∟ word | string | 是 | 敏感词内容 |
∟ x1 | Number | 否 | 位置信息,对应目标矩形左上角横坐标相对坐标 |
∟ y1 | Number | 否 | 位置信息,对应目标矩形左上角纵坐标相对坐标 |
∟ x2 | Number | 否 | 位置信息,对应目标矩形右下角横坐标相对坐标 |
∟ y2 | Number | 否 | 位置信息,对应目标矩形右下角纵坐标相对坐标 |
∟ libInfos | Object[] | 是 | 命中的自定义图片名单信息 |
∟ entity | String | 是 | 该图片命中自定义图片名单对应原始添加的根源图片url |
∟ hitCount | Number | 是 | 历史针对该数据源图片命中所有次数 |
∟ value | String | 否 | 图片中包含的可识别内容 |
∟ group | String | 否 | value对应的分组名称,用于对value的解释 |
∟ hitInfos | Object[] | 是 | 命中的线索信息 |
∟ value | String | 是 | 图片中包含的可识别内容 |
∟ group | String | 否 | value对应的分组名称,用于对value的解释 |
∟ x1 | Number | 否 | 位置信息,对应目标矩形左上角横坐标相对坐标 |
∟ y1 | Number | 否 | 位置信息,对应目标矩形左上角纵坐标相对坐标 |
∟ x2 | Number | 否 | 位置信息,对应目标矩形右下角横坐标相对坐标 |
∟ y2 | Number | 否 | 位置信息,对应目标矩形右下角纵坐标相对坐标 |
∟ anticheat | Object | 否 | 命中的反作弊信息 |
∟ hitType | Number | 是 | 反作弊命中类型,详见hitType返回码及含义表 |
∟ ocr | Object | 否 | OCR结果信息,OCR功能需额外付费开启,如有需要请联系您的专属商务,未开通状态下此数组返回为空 |
∟ taskId | String | 是 | 检测任务ID,示例值:"fx6sxdcd89fvbvg4967b4787d78a" |
∟ dataId | String | 否 | 子数据唯一标识 |
∟ speakerId | String | 否 | 针对接入SDK监听客户,返回说话人ID信息 |
∟ beginTime | String | 是 | 直播当前时间点,单位为毫秒 |
∟ endTime | String | 是 | 直播当前时间点,单位为毫秒 |
∟ height | Number | 是 | 截图高度,单位像素 |
∟ width | Number | 是 | 截图宽度,单位像素 |
∟ details | Object[] | 否 | 截图 OCR 命中的详细信息 |
∟ content | String | 是 | 该图片中所有的文字信息集合 |
∟ lineContents | Object[] | 是 | OCR行信息 |
∟ lineContent | String | 是 | 每行的文字信息 |
∟ lang | String | 否 | 语种信息 |
∟ x1 | Number | 否 | 位置信息,对应目标矩形左上角横坐标相对坐标 |
∟ y1 | Number | 否 | 位置信息,对应目标矩形左上角纵坐标相对坐标 |
∟ x2 | Number | 否 | 位置信息,对应目标矩形右下角横坐标相对坐标 |
∟ y2 | Number | 否 | 位置信息,对应目标矩形右下角纵坐标相对坐标 |
∟ discern | Object | 否 | 物体识别结果,支持对截图中物体进行识别,识别结果返回需额外付费开启,如有需要请联系您的专属商务,未开通状态下此数组返回为空 |
∟ taskId | String | 是 | 检测任务ID,示例值:"fx6sxdcd89fvbvg4967b4787d78a" |
∟ dataId | String | 否 | 子数据唯一标识 |
∟ speakerId | String | 否 | 针对接入SDK监听客户,返回说话人ID信息 |
∟ beginTime | String | 是 | 直播当前时间点,单位为毫秒 |
∟ endTime | String | 是 | 直播当前时间点,单位为毫秒 |
∟ details | Object[] | 否 | 物体识别命中的详细信息 |
∟ discernName | String | 是 | 识别物体名称 |
∟ rate | Number | 是 | 识别分数,0-1之间取值,1为置信度最高,0为置信度最低。 |
∟ type | Number | 是 | 图片识别类型,3 通用识别 |
响应体示例
{
"code":200,
"msg":"ok",
"result":[
{
"antispam":{
"taskId":"09f0da093c334673b557266801158778",
"dataId":"1631935360902",
"censorSource":2,
"status":1,
"evidences":{
"evidence":{
"suggestion":2,
"type":1,
"url":"https://yidun-video.nos-eastchina1.126.net/09f0da093c334673b557266801158778_65108_1631935372803.jpg?Signature=TZ6%2Bwbg9w4L3nIXbcjwXOCdWLGGi4K2xHrRKj2%2BFWeo%3D&Expires=1634527373&NOSAccessKeyId=7b107844ee8e4f9689d54c726e3273ff",
"beginTime":1631935372765,
"endTime":1631935372765,
"speakerId":"65108",
"frontPics":[
{
"url":"https://yidun-video.nos-eastchina1.126.net/09f0da093c334673b557266801158778_65108_1631935362135.jpg?Signature=DC8L2OwyitZGAKYFG9m%2FeVWKLQm9jiapHzLgipi%2B3OM%3D&Expires=1634527373&NOSAccessKeyId=7b107844ee8e4f9689d54c726e3273ff"
},
{
"url":"https://yidun-video.nos-eastchina1.126.net/09f0da093c334673b557266801158778_65108_1631935367629.jpg?Signature=s3hsY8zuhAxI9byiwN02m4YLjftIp6bcROSVvyo%2FuTM%3D&Expires=1634527373&NOSAccessKeyId=7b107844ee8e4f9689d54c726e3273ff"
}
]
},
"labels":[
{
"label":100,
"level":2,
"rate":0.999936,
"subLabels":[
{
"subLabel":10002,
"rate":0.9998,
"details":{
"hitInfos":[
{
"value":"女胸",
"group":"色情部位分组"
}
]
}
},
{
"subLabel":10004,
"rate":0.988,
"details":{
"hitInfos":[
{
"value":"性行为",
"group":"色情部位分组"
}
]
}
}
]
}
]
},
"riskLevel":0,
"riskScore":0
}
}
]
}
响应返回码
响应返回码见:响应返回码
SDK接入方法
为方便 JAVA 开发者调试和接入API,我们提供了配套的开发工具集(SDK),用于简化API接入流程。SDK中各接口调用方式基本相同,接入方式统一,并提供了一些接口调用过程中常见的异常处理方案。以下介绍了SDK的使用流程,以及首次使用SDK的简单示例。
如果您使用的是其他语言,请参考各语言示例demo。
- 准备工作
准备步骤详见通用步骤
- 使用方法
使用方法可参考使用SDK