停止审核 StopDetection--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

停止审核 StopDetection

最近更新时间：2024.06.26 11:46:25首次发布时间：2022.03.16 15:12:04

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

使用说明

接口行为

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

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

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"
    }
}

错误码

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