You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

开启审核 StartDetection

最近更新时间：2024.02.29 19:30:23

首次发布时间：2022.03.16 15:12:04

我的收藏

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

使用说明

接口行为

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

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

前置条件

  • 已开通 RTC 服务。参考开通服务。
  • 已实现 RTC 的视频/音频通话。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

请求说明

  • 请求方式：POST
  • 请求地址：https://rtc.volcengineapi.com?Action=StartDetection&Version=2020-12-01

请求参数

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

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
是
StartDetection
接口名称。当前 API 的名称为 StartDetection。
Version
String
是
2020-12-01
接口版本。当前 API 的版本为 2020-12-01。

Body

参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
应用的唯一标志
RoomId
String
是
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 会按设定的音频切片时长，保存每段音频切片，并对切片进行审核。若出现违规信息，会返回审核结果。

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

回调种类。

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

返回参数

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

参数
类型
示例值
描述
Message
String
success
仅在请求成功时返回"success",失败时为空

请求示例

POST https://rtc.volcengineapi.com?Action=StartDetection&Version=2020-12-01

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StartDetection",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "success"
    }
}

错误码

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