You need to enable JavaScript to run this app.
导航
停止审核 StopDetection
最近更新时间:2024.06.20 15:25:20首次发布时间:2024.01.05 15:35:17

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

在实时音视频通话场景中,你可以通过调用此接口停止对房间内指定用户发送的内容进行的审核。

房间级审核不支持停止单流审核的操作,会引发错误。

请求说明

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

调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
661e****543cf
你的音视频应用的唯一标志,参看获取 AppId
RoomId
String
Room1
房间 ID,是房间的唯一标志
UserId
String
User1
用户 ID

返回参数

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

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

请求示例

POST https://rtc.volcengineapi.com?Action=StopDetection&Version=2023-11-01
{
  "AppId": "661e****543cf",
  "RoomId": "Room1",
  "UserId": "user1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "StopDetection",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "success"
    }
}

错误码

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