使用说明

在开始调用服务端 API 接口之前，请确保：

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppId 和 ServerSecret，详情请参考 控制台 - 项目信息。
• 已准备好自己的客户端，搭建相关的业务场景。
• 已经在 ZEGO 控制台 配置了接收审核结果的回调地址。

1. 配置公共请求参数

开发者调用每个 ZEGO 服务端 API 前，需要先配置 API 的公共请求参数。

公共请求参数，是指每个接口都需要使用到的请求参数，包含了 AppId、Signature（指 2 生成的签名信息）、SignatureNonce（随机字符串）、Timestamp（时间戳）等参数，请根据实际情况修改。公共参数的具体介绍，请参考 调用方式 中的 “2.1 公共请求参数”。

https://rtc-api.zego.im/?Action=StartCensorAudio
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureVersion=2.0
&IsTest=false

开发者可以在 服务端 API 校验 页面中，输入 URL 地址，验证签名信息、公共参数、以及 URL 格式是否合法。

2. 配置 API 相关业务参数

配置完公共参数后，再去配置 API 相关的业务参数，设定所需的目标操作。

业务参数的具体介绍，请参考：

• 开始音频流审核：StartCensorAudio 中的 “3 请求参数”。
• 开始视频流审核：StartCensorVideo 中的 “3 请求参数”。

3. 开发者的服务端发起请求

以上配置完成后，开发者的服务端可以通过 URL 地址，向 ZEGO 服务端发送请求。

请求示例如下：

https://rtc-api.zego.im/?Action=StartCensorAudio
&RoomId=RoomAudio
&StreamId=StreamId_1635941431395593000
&AudioType[]=1
&ReturnAllText=1
&ReturnPreText=1
&ReturnPreAudio=1
&ReturnFinishInfo=1
&<公共请求参数>

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
&<公共请求参数>

4. ZEGO 服务端响应请求，并通过回调地址返回审核结果

ZEGO 服务端接收到开发者的请求信息后，返回响应的信息。

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

返回信息字段中，如果 Code 为 “0” 表示请求成功；如果不为 “0” 则表示请求失败，请参考 全局返回码 处理。

通过您在 ZEGO 控制台 配置的回调地址，获取详细的审核结果，回调结果说明请参考：

• 音频流审核回调
• 视频流审核回调

音/视频流审核仅支持异步返回审核结果。开发者可以根据回调结果，进行业务侧的风控处理，比如对违规用户进行断流、禁言、封号等。

在使用 Express SDK 实现推流自动审核之前，请确保：

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 AppSign，详情请参考 控制台 - 项目信息。
• 已在项目中集成 ZEGO Express SDK，实现基本的实时音视频功能，详情请参考 实时音视频 - 快速开始 - 实现视频通话。
• 已经在 ZEGO 控制台 配置了接收审核结果的回调地址。

1. 调用推流接口，配置参数，开始自动审查

在调用推流接口 startPublishingStream 时，配置参数 ZegoPublisherConfig.streamCensorshipMode，自动开始审查。

以 Android 实现代码为例：

//预览
engine.startPreview(previewCanvas);
// Start publishing stream
ZegoPublisherConfig config = new ZegoPublisherConfig();
config.roomID = "xxx";
//根据实际选择，填入不同的审核音视频参数
config.streamCensorshipMode = ZegoStreamCensorshipMode.AUDIO_AND_VIDEO;

engine.startPublishingStream(publishStreamID,config,ZegoPublishChannel.MAIN);

2. ZEGO 服务端响应请求，并通过回调地址返回审核结果

ZEGO 服务端接收到开发者的请求信息后，返回响应的信息。

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

返回信息字段中，如果 Code 为 “0” 表示请求成功；如果不为 “0” 则表示请求失败，请参考 全局返回码 处理。

通过您在 ZEGO 控制台 配置的回调地址，获取详细的审核结果，回调结果说明请参考：

• 音频流审核回调
• 视频流审核回调

音/视频流审核仅支持异步返回审核结果。开发者可以根据回调结果，进行业务侧的风控处理，比如对违规用户进行断流、禁言、封号等。

音频流识别 和 视频流识别 之外的 4 类内容，ZEGO 没有封装对应的接口和使用方案，需要您参考数美的文档，自行发起服务端请求，并通过返回值或回调结果，进行业务侧逻辑处理。

在您自行接入数美审核服务前，请确保：

• 已参考 控制台 - 云市场 - 数美内容审核，按照页面指引，自助开通 数美内容审核 相关权限。
• 已联系 ZEGO 商务人员，加入了您、数美、ZEGO 三方对接群。
• 请确保已知悉如下信息：