StartCensorVideoV2

POST

https://rtc-api.zego.im/

视频流审核是 ZEGO 实时音视频产品的互动扩展服务。开发者通过视频流审核接口，可以调用实时视频审核对视频中的音频和画面进行审核，包括音频的语义和特征（音调、音色、声纹、旋律等）识别，视频画面中的文字语义和内容的识别。ZEGO 会通过视频流审核回调或配置的自定义回调地址，把识别结果发送给开发者，开始视频流审核功能与结束视频流审核请结合使用。

注意

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

调用频率限制

同一个 AppID 下所有房间：100 次/秒

Request

Query Parameters

Action stringrequired

Possible values: [StartCensorVideoV2]

接口原型参数

https://rtc-api.zego.im?Action=StartCensorVideoV2

AppId uint32required

💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce stringrequired

💡公共参数。随机字符串。

Timestamp int64required

💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡公共参数。签名版本号。

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

application/json

Body

required

RoomId stringrequired

需要进行音频审核的房间 ID。默认会将该房间内的所有流送审，如果房间内有流不需要送审（比如受信任的用户所推的流），请在调用客户端 SDK 'startPublishingStream' 推流时，将 'ZegoPulisherConfig.streamCensorshipFlag' 设置为不允许送审。

EventId stringrequired

场景标识。

通过该参数标识音频流对应的场景。审核策略可以根据场景进行调整，从而实现不同的场景审核尺度的控制。

直播：live_streaming
1v1：private_chat

如果以上可选值不能完全满足您的使用诉求，请联系 ZEGO 技术支持。

Language string

Possible values: [zh, en, ar]

语言类型，对音频和截帧识别的语种类型：

zh：中文（默认值）
en：英文
ar：阿拉伯语

AudioParam object

音频的参数，不传则不审核音频流

RiskTypeList string[]

风险审核类别。

RiskTypeList 与 BusinessTypeList 至少一个不为空，如果二者同时为空，则不审核音频，仅审核视频。数组中可添加的值如下：音频语义：

EROTIC：色情
DIRTY：辱骂
POLITY：涉政
BAN：违禁
VIOLENT：暴恐
ADVERT：广告

音频特征：

MOAN：娇喘
ANTHEN：国歌识别
BANEDAUDIO：违禁歌曲

如需其他特征，请联系 ZEGO 技术支持。

BusinessTypeList string[]

业务识别类别。

RiskTypeList 与 BusinessTypeList 至少一个不为空，如果二者同时为空，则不审核音频，仅审核视频。数组中可添加的值如下：音频语义:

MOINIR：未成年人

音频特征：

SING：唱歌
LANGUAGE：语种识别
VOICE：人声属性识别

如需其他特征，请联系 ZEGO 技术支持。音频流的识别并不仅限于违规内容，也可以辅助开发者进行业务运营。如果以上可选值无法满足您的业务诉求，请联系 ZEGO 技术支持。

AudioLanguage string[]

Possible values: [zh, ja, ko, th, vi, ms, tl, id, hi, ar, tr, en, es, pt, it, fr, de, ru]

视频流中的音频语种。

在需要识别音频的语义时，请准确传入该值。可选值：

zh：中文、ja：日语、ko：韩语、th：泰语
vi：越南语、ms：马来语、tl：菲律宾语、id：印尼语
hi：印地语中、ar：阿拉伯语、tr：土耳其语、en：英文
es：西班牙语、pt：葡萄牙语、it：意大利语、fr：法语
de：德语、ru：俄语

ReturnAllText int32

Possible values: [0, 1]

Default value: 0

是否返回当前 10s 片段的所有文本：

0：（默认值）返回风险等级为非 PASS 的音频片段文本
1：返回所有风险等级的音频文本片段

审核结果的风险等级将分为以下三类：

PASS：正常内容，建议直接放行。

REVIEW：可疑内容，建议人工审核。

REJECT：违规内容，建议直接拦截。

ReturnPreText int32

Possible values: [0, 1]

Default value: 0

是否返回违规片段的前一个片段文本：

0：（默认值）不返回违规片段前一个 10s 片段文字
1：返回违规片段前一个 10s 片段文字

ReturnPreAudio int32

Possible values: [0, 1]

Default value: 0

是否返回违规片段的前一个音频片段链接：

0：（默认值）不返回违规片段前一个 10s 片段音频，只返回违规片段音频链接
1：返回违规片段前一个 10s 片段音频链接

ResultCallbackUrl string

自定义审核结果的回调地址。如果您需要将此次审核任务的审核结果，通过其他的回调地址抛出，可以通过本参数实现。如果不需要，可以在 ZEGO 控制台配置统一的回调地址，详情请参考控制台 - 云市场 - 数美内容审核。

StatusCallbackUrl string

自定义审核状态回调地址。如果您需要将此次审核任务的审核状态，通过其他的回调地址抛出，可以通过本参数实现。如果不需要，可以在 ZEGO 后台配置统一的回调地址，详情请参考控制台 - 云市场 - 数美内容审核。

VideoParam objectrequired

视频审核相关参数

RiskTypeList string[]

风险审核类别。

RiskTypeList 与 BusinessTypeList 至少一个不为空。数组中可添加的值如下：

画面文字语义：

IMGTEXTRISK：基础违规识别，包含多个常见标签（涉政、暴恐、违禁、色情、辱骂、广告、灌水隐私、广告法）

画面内容：

POLITY：涉政
EROTIC：色情、性感
VIOLENT：暴恐、违禁
QRCODE：二维码
ADVERT：广告

如果以上可选值无法满足您的业务诉求，请联系 ZEGO 技术支持。

BusinessTypeList string[]

业务识别类别。

RiskTypeList 与 BusinessTypeList 至少一个不为空。数组中可添加的值：

画面内容:

AGE：未成年人
PHOTOMATERIALLOGO：CFP 等版权 LOGO，还支持其他十余种 LOGO，详情请联系技术支持了解。

画面内容扩展：

FACEDETECTION：人脸检测
BEAUTY：颜值打分

视频流的识别并不仅限于违规内容，也可以辅助开发者进行业务运营。如果以上可选值无法满足您的业务诉求，请联系 ZEGO 技术支持。

ReturnAllImg int32

Possible values: [0, 1]

Default value: 0

视频流截帧的风险等级，建议传入 1：

0：（默认值）返回风险等级为非 PASS 的截帧审核信息
1：返回所有风险等级的截帧审核信息

审核结果的风险等级将分为以下三类：

PASS：正常内容，建议直接放行
REVIEW：可疑内容，建议人工审核
REJECT：违规内容，建议直接拦截

DetectFrequency int32

截帧频率。单位：秒。默认为 3s 截帧一次进行审核。

ResultCallbackUrl string

自定义审核结果的回调地址。

如果您需要将此次审核任务的审核结果，通过其他的回调地址抛出，可以通过本参数实现。如果不需要，可以在 ZEGO 控制台配置统一的回调地址，详情请参考控制台 - 云市场 - 数美内容审核。

StatusCallbackUrl string

自定义审核状态回调地址。

如果您需要将此次审核任务的审核状态，通过其他的回调地址抛出，可以通过本参数实现。如果不需要，可以在 ZEGO 后台配置统一的回调地址，详情请参考控制台 - 云市场 - 数美内容审核。

ReturnFinishInfo int32

Possible values: [0, 1]

Default value: 0

审核任务结束时，是否进行"审核任务状态"回调：

0：审核结束时不发送结束通知
1：审核结束时发起结束通知

Responses

成功

application/json

Schema
Example (from schema)

Schema

Code int32

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

返回码	说明	处理建议
50006、50007	HTTP 请求失败。	请稍后重试（建议 300s），或联系 ZEGO 技术支持。
50009	审核失败。	请稍后重试（建议 300s），或联系 ZEGO 技术支持。
50117	配置错误，未开通数美权限。	请参考控制台 - 云市场 - 数美内容审核，按照页面指引，自助开通 `数美内容审核` 相关权限。

Message string

操作结果描述

RequestId string

请求 ID

Data object

响应数据

TaskId string

审核任务 ID，用于结束审核任务

{
  "Code": 0,
  "Message": "success",
  "RequestId": "TestRequestId1722597387688544000",
  "Data": {
    "TaskId": "05e7a786a5191e8f5eb8e5851b01afcd"
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "TestRequestId1722597387688544000",
  "Data": {
    "TaskId": "05e7a786a5191e8f5eb8e5851b01afcd"
  }
}

CURL

Base URL

https://rtc-api.zego.im

统一接入地址（不区分区域）

Parameters

Actionqueryrequired

AppIdqueryrequired

SignatureNoncequeryrequired

Timestampqueryrequired

Signaturequeryrequired

SignatureVersionqueryrequired

IsTestquery

Bodyrequired

{
  "RoomId": "room_1",
  "EventId": "live_streaming",
  "Language": "zh",
  "AudioParam": {
    "RiskTypeList": [
      "ADLAW",
      "ADVERT",
      "AUDIOPOLITICAL",
      "DIRTY",
      "EROTIC",
      "MOAN",
      "POLITY"
    ],
    "BusinessTypeList": [
      "string"
    ],
    "AudioLanguage": [
      "zh"
    ],
    "ReturnAllText": 1,
    "ReturnPreText": 1,
    "ReturnPreAudio": 1,
    "ResultCallbackUrl": "",
    "StatusCallbackUrl": ""
  },
  "VideoParam": {
    "RiskTypeList": [
      "ADVERT",
      "EROTIC",
      "IMGTEXTRISK",
      "POLITY",
      "QRCODE",
      "VIOLENT"
    ],
    "BusinessTypeList": [
      "string"
    ],
    "ReturnAllImg": 1,
    "DetectFrequency": 5,
    "ResultCallbackUrl": "",
    "StatusCallbackUrl": ""
  },
  "ReturnFinishInfo": 1
}

RESPONSEClear

Click the "Send" button above and see the response here!

StartCensorVideoV2

https://rtc-api.zego.im/

Request

Query Parameters

Body

Responses​

Responses