停止检测
2024.11.21 16:41:44
内容安全直播音视频检测中的数据,客户可以通过调用停止检测接口进行停止
接口说明
该接口返回停止检测接口调用的结果,直播检测任务会异步停止
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持 MD5,SHA1,SHA256,SM3 几种加密算法,详细信息,请参见接口鉴权
结果说明
- 接口支持多次调用,调用成功后检测任务最终会停止
- 接口一次调用最多支持 100 路直播
- 接口请求频率建议 1s 一次,过快服务器会拒绝处理,客户可以根据业务需求进行适当调整
接口耗时
停止检测接口正常 1s 内返回结果,业务方根据需求适当调整超时时间,建议为 3s
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | http://as.dun.163.com/v1/livewallsolution/feedback |
HTTP Method | POST |
请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | String | 是 | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数
业务参数
名称 | 类型 | 必填 | 最大长度 | 描述 |
---|---|---|---|---|
version | String | 是 | 4 | 接口版本号,可选值v1 |
realTimeInfoList | String | 是 | 直播信息更新数据(Json数组),提交时转换为string格式 | |
∟taskId | String | 是 | 32 | 待停止检测的直播音视频taskId,示例值:"38e08da8d2574df4bd2eca9b5153df72" |
∟barrageCount | Number | 否 | 2^31-1 | 直播音频实时弹幕数 |
∟garbageBarrageCount | Number | 否 | 2^31-1 | 直播音频实时垃圾弹幕数 |
∟status | Number | 是 | 3 | 直播音视频检测状态, 100-停止检测 |
∟censorReplayUrl | String | 否 | 2048 | 直播回放地址,支持针对已结束的直播进行回放 |
∟livingSpeakerInfo | Object | 否 | 针对接入SDK监听场景,填入在房间内全部说话人的信息;对审核墙画面更新有时效性的要求时建议使用 | |
∟livingSpeakerIds | Object[] | 否 | 每个Id 128 | 房间内的说话人信息 |
∟updateTime | Number | 否 | 13 | 更新时间,作用于排序 |
请求体示例
version=v1&signature=xxx&secretId=xxx=realTimeInfoList=[{taskId:29g3jw7c3iwduhdy09rc84ig00109s6,status:100}]
响应
该接口可以返回停止检测接口的调用结果。
响应结果
响应字段如下,响应公共字段已省略,详细见响应公共字段,详细字段信息如下:
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
result | Object[] | 是 | 停止检测结果 |
taskId | String | 是 | 直播音视频任务 ID,示例值:"38e08da8d2574df4bd2eca9b5153df72" |
result | Number | 是 | 停止状态,0-成功,1-失败,2-数据不存在 |
响应体示例
{
"code":200,
"msg":"ok",
"result":[
{
"taskId": "38e08da8d2574df4bd2eca9b5153df72",
"result": 0
}
]
}
响应返回码
响应返回码见:响应返回码
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引 了解更多。
Github Demo 地址
Gitee Demo 地址(Github 无法访问时选择)
该接口的使用方法可参考SDK demo