文档中心
超低延迟直播
服务端 API
音视频流审核接口
开始视频流审核

开始视频流审核

更新时间：2024-04-01 18:43

1 描述

视频流审核是配套 ZEGO 实时音视频产品的内容安全服务。该服务提供实时的视频流内容识别与审核，开发者只需调用视频流审核接口即可实时检测视频中是否出现违规内容，ZEGO 会通过回调把违规信息发送给开发者指定的 URL。相关回调说明请参考视频流审核回调。

使用该接口前，请参考控制台 - 云市场 - 数美内容审核，按照页面指引，自助开通 数美内容审核 相关权限。

2 接口原型

请求方法：GET
请求地址：https://rtc-api.zego.im/?Action=StartCensorVideo
传输协议：HTTPS
调用频率限制（同一个 AppID 下所有房间）：100 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
RoomId	String	是	房间 ID。
StreamId	String	是	拉流 ID。若同时填写 StreamId 和 StreamUrl，则 StreamUrl 生效。
StreamUrl	String	否	拉流地址 URL，支持 RTMP、RTMPS、HTTP-FLV 协议。 StreamId 和 StreamUrl 二者取其一即可，若同时填写 StreamId 和 StreamUrl，则 StreamUrl 生效。
ImageType[]	Array of UInt32	是	视频流截帧识别类型。 1：涉政识别 2：涉政人物识别 3：暴恐识别 4：色情识别 5：广告识别 6：视频水印 logo 识别 7：不良场景识别，支持吸烟、喝酒、赌博、吸毒、避孕套和无意义画面 8：公众人物识别 9：行业违规识别 10：OCR（图片文字识别）
AudioType[]	Array of UInt32	是	视频流中的音频流识别类型。 0：不识别音频 1：色情识别 3：广告识别 4：涉政识别 5：娇喘识别 8：语种识别
ReturnAllImage	Int32	否	是否回调所有的截帧图片审核结果。 0：仅回调 RiskLevel 为 1（review）、2（reject）的截帧图片审核信息，默认值。 1：回调所有 RiskLevel 的截帧图片和相关审核信息。更多回调信息，请参考视频流审核回调。
ReturnAllText	Int32	否	是否回调所有的音频流片段识别结果和文本内容。 0：仅回调 RiskLevel 为 2（reject）的音频流片段识别结果和文本内容，默认值。 1：回调所有 RiskLevel 的音频流片段识别结果和文本内容。更多回调信息，请参考视频流审核回调。
ReturnFinishInfo	Int32	否	审核结束时通知。 0：关闭，默认值。 1：打开。
DetectFrequency	Int32	是	视频流截帧的频率（单位：秒），取值范围为 [1, 60]，推荐值为 3。例如设置为 10 时，表示每 10 秒截一帧。
DetectStep	Int32	否	视频流截帧图片检测步长，已截帧图片每个步长只会检测一次，请确保充分理解该参数的意义后再使用。该参数取值必须大于等于 1。默认值为 1，表示每张截帧图片都检测。例如，设置为 5 时，表示间隔 4 张截帧图片检测一次，并以此类推。截帧频率通过参数 DetectFrequency 进行设置。
CallbackUrl	String	否	自定义审核结果的回调通知地址。如果您需要将不同流的审核结果、通过不同的回调地址抛出，可以通过本参数实现。

4 请求示例

https://rtc-api.zego.im/?Action=StartCensorVideo
&RoomId=RoomVideo
&StreamId=StreamId_1635941431395593000
&ImageType[]=1
&ImageType[]=2
&AudioType[]=1
&ReturnAllImage=1
&ReturnAllText=1
&ReturnFinishInfo=1
&DetectFrequency=1
&DetectStep=5
&CallbackUrl=自定义回调地址
&<公共请求参数>

5 响应参数

参数	类型	描述
Code	Int32	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
Data	Object	响应数据。
TaskId	String	任务 ID（用于结束审核）。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"TestRequestId1635941434402250000",
    "Data":
       {
           "TaskId":"0ecdeab2f69c4ba594d32c536a1c9fcb"
       }
}

7 返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
50006、50007	HTTP 请求失败。	请稍后重试，或联系 ZEGO 技术支持。
50009	审核失败。	请稍后重试，或联系 ZEGO 技术支持。
50117	配置错误，未开通数美权限。	请联系 ZEGO 技术支持开通数美相关权限。