提交检测
2023.09.28 10:49:51
直播视频异步检测接口帮助您检测直播视频画面中的违规内容和多维度的辅助信息，提供包括智能鉴黄、暴恐、涉政、违禁、广告、恶心、涉价值观等违规内容识别能力，以及logo识别、OCR识别、人脸识别、直播视频质量等多维度辅助信息能力，直播视频中的违规内容和多维度的辅助信息异步获取
接口说明
该接口异步提交直播视频检测任务，返回直播视频标识,支持http协议接口调用
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature 参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权
直播视频要求
- 直播视频支持类型：URL
- 直播视频支持流媒体协议：rtp、srtp、rtmp、rtmps、mmsh、mmst、hls、http、tcp、https等
- 直播视频拉流：拉流超时时间默认为150s,超时后直播视频检测任务将自动停止
检测耗时
直播视频异步检测只是提交直播检测任务，拉流及检测这些逻辑异步完成，建议您将超时时间设置为2秒
历史版本
请求
| 名称 | 值 |
|---|---|
| HTTP URL | http://as.dun.163.com/v4/livevideo/submit |
| HTTP Method | POST |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | String | 是 | 固定值："application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数
业务参数
| 名称 | 类型 | 必填 | 最大长度 | 描述 |
|---|---|---|---|---|
| version | String | 是 | 4 | 接口版本号，值为v4 |
| url | String | 是 | 1024 | 直播流地址 |
| dataId | String | 是 | 128 | 上传数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询 |
| scFrequency | Number | 否 | 4 | 截图检测频率，默认5秒截图检测一次，可设置范围为0.5~600秒 |
| callback | String | 否 | 512 | 数据回调参数，调用方根据业务情况自行设计，当调用离线结果获取接口或查询接口时，该接口会原样返回该字段，详细见音频离线检测结果获取。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。 |
| callbackUrl | String | 否 | 256 | 离线结果回调通知到客户的URL。主动回调数据接口超时时间默认设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。 |
| uniqueKey | String | 否 | 64 | 客户个性化直播流唯一性标识，传入后，将以此值作为重复检测依据，若不传，默认以URL作为查重依据 |
请求体示例
url=testurl&version=v4&signature=xxx&secretId=xxx&businessId=xxx
响应
响应结果
响应字段如下，响应公共字段已省略，详细见响应公共字段：
| 名称 | 类型 | 必须返回 | 描述 |
|---|---|---|---|
| result | Object | 是 | 直播视频提交检测结果 |
| ∟ taskId | String | 是 | 本次请求数据标识，可以根据该标识查询数据最新结果 |
| ∟ status | Number | 是 | 请求结果，0成功，1失败 |
响应体示例
{
"code": 200,
"msg": "ok",
"result": {
"taskId": "*****",
"status": 0
}
}
响应错误码
错误码有公共错误码和业务错误码两部分组成，公共错误码见：公共错误码
接入示例代码
开发工具集（SDK）接入
为方便 JAVA 开发者调试和接入API，我们提供了配套的开发工具集（SDK），用于简化API接入流程。SDK中各接口调用方式基本相同，接入方式统一，并提供了一些接口调用过程中常见的异常处理方案。以下介绍了SDK的使用流程，以及使用SDK的简单示例。
- 准备工作
准备步骤详见通用步骤
- 使用方法
该接口的使用方法可参考SDK demo
API接入
如果您选择非SDK接入，使用API方式接入，请参考各开发语言汇总示例代码
该接口的使用方法具体示例如下：
