You need to enable JavaScript to run this app.
导航

停止审核 StopDetection

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

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

在开启审核后,你可以使用 StopDetection 接口关闭审核。

使用说明

接口行为

你可以使用 StopDetection 接口,停止对房间内指定用户发送的内容进行审核。

如果你在房间级审核中发起停止单流审核,会引发错误。

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
Your_AppId
应用的唯一标志
RoomId
String
Your_RoomId
房间 ID,是房间的唯一标志
UserId
String
Your_UserId
用户 ID

返回参数

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

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

请求示例

POST https://rtc.volcengineapi.com?Action=StopDetection&Version=2020-12-01
{
  "AppId": "Your_AppId",
  "RoomId": "Your_RoomId",
  "UserId": "Your_UserId"
}

返回示例

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

错误码

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