You need to enable JavaScript to run this app.
导航
封禁房间&用户 BanRoomUser
最近更新时间:2024.07.16 15:31:22首次发布时间:2024.01.03 20:25:19

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

在实时音视频通话场景中,若需解散房间或移除指定用户,你可通过调用此接口实现。

通过指定应用标识和房间标识,你可封禁整个房间;若同时指定用户标识,可封禁并移除该用户。操作完成后,被移出用户会收到 -1006 的错误码,如果被移出用户是可见用户,房间中其他用户会收到 onUserLeave 回调。

注意事项

请求频率:QPS 不得超过 20

请求说明

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

调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
661e****543cf
你的音视频应用的唯一标志,参看获取 AppId
RoomId
String
Room1
指定房间 ID
UserId
String
User1
希望封禁用户的 ID
ForbiddenInterval
Integer
0
封禁时长,取值范围为 [60,259200],单位为秒。
若传入值为空或 0 表示允许用户重新进房。
若传入值大于 0,且小于 60,自动修改为 60
若传入值大于 259200,自动修改为 259200

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构

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

请求示例

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

返回示例

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

错误码

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