本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在你的音视频应用中，你可能需要对用户通过 RTC 发送的视频、音频内容进行审核，识别其中违规内容信息，供后续处理。
你可以使用 StartDetection 这个 OpenAPI 实现这一功能。

使用说明
接口行为

你可以使用 StartDetection 接口，对房间内指定用户通过 RTC 发送的视频和音频内容开启安全审核，识别其中内容违规信息。若可能存在违规，你指定的地址会收到违规信息回调。

若任务运行中，重复调用开始接口进行相同审核操作，如指定相同用户或指定重复审核类型，不会导致请求失败，BaseResponse.Result 会提示 The task has been started. Please do not call the startup task interface repeatedly。

首次调用 StartDetection 接口时，会初始化审核相关资源，用时大概 1 分钟，在此期间可能会由于准备资源而漏审。

前置条件
调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

请求说明
请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query
参数类型是否必选示例值描述
ActionString是StartDetection接口名称。当前 API 的名称为 StartDetection。
VersionString是2023-11-01接口版本。当前 API 的版本为 2023-11-01。
Body
参数类型是否必选示例值描述
AppIdString是Your_AppId应用的唯一标志
RoomIdString是Your_RoomId房间 ID，是房间的唯一标志

UserId

String

否

Your_UserId

用户 ID，要审核的用户ID。若不填，则审核房间内所有推流用户。最多可以审核 17 路流。

  • 如果先发起单流审核 再发起房间级审核，会发起房间级审核并停止单流审核；
  • 如果先发起房间级审核，再发起单流审核，会引发错误，提示：已有审核进行中；
  • 如果先发起单流音频审核和单流视频审核，再发起房间音频审核，会合并单流音频审核到房间音频审核，单流视频审核无变化；
  • 如果先发起单流音频审核和单流视频审核，再发起房间音频审核，之后又发起房间音视频审核，会合并所有审核到房间音视频审核。

Callback

String

否

http://xxx.xxx.xxx/xxx/callback

回调地址
开启审核后，如果可能存在违规信息，此地址会收到违规信息回调。如果地址无效或为空，审核会继续，但不会收到违规信息的回调结果。

MediaType

Integer

否

1

进行审核的内容类型：

  • 1：视频截图；
  • 2：音频切片；
  • 3：视频截图+音频切片（默认值）

视频截图：审核过程中，RTC 会按照设定的时间间隔，进行周期性截图，并对截图进行审核。若出现违规信息，会返回审核结果。
音频切片：审核过程中，RTC 会按设定的音频切片时长，保存每段音频切片，并对切片进行审核。若出现违规信息，会返回审核结果。

IntervalInteger否2000相邻截图之间的间隔时间，范围为[100，600000]。单位 ms。默认值为2000。
DurationInteger否20000每段音频切片的时长，范围为[1000，600000]。单位 ms。默认值为20000。该参数不建议设置过大，如果设置过大, 会出现审核延迟的问题，且造成最后一段切片计费误差向上取整偏大。
IdleSecInteger否180任务最大空闲超时时间。如果指定的用户停止推流或素材间隔过长，导致素材接收不到，那么审核任务会在空闲时间超过设定值后自动停止。值的范围为[1，10800]，单位为秒。默认值为180。

CallbackType

Integer

否

0

回调种类。

  • 0：违规回调
  • 1：全部回调。
    默认值为 0。
返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数类型示例值描述
MessageStringsuccess仅在请求成功时返回"success",失败时为空
请求示例 
POST https://rtc.volcengineapi.com?Action=StartDetection&Version=2023-11-01

{
    "AppId": "Your_AppId",
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "Callback": "http://xxx.xxx.xxx/r/callback/v1"
}

json
返回示例 
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StartDetection",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "success"
    }
}

json
错误码

您可访问公共错误码，获取更多错误码信息。