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

封禁房间&用户 BanRoomUser

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

首次发布时间：2023.04.12 10:53:08

我的收藏

在你的音视频应用中，你可能会需要封禁整个房间或房间内指定用户，以解散整个房间或移除指定用户。你可以使用 BanRoomUser 这个 OpenAPI 实现这一功能。

使用说明

接口行为

你可以调用 BanRoomUser 接口，指定你所属的 AppId和RoomId,封禁整个房间，或指定 AppId、RoomId和UserId封禁并移除房间内指定用户。
完成移出后，被移出用户会收到 -1006 的错误码；如果被移出用户是可见用户，房间中其他用户会收到 onUserLeave 回调。

调用接口

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

注意事项

请求频率：QPS 不得超过 20。

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

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

请求示例

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

{
    "AppId": "Your_AppId",
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "ForbiddenInterval": 0
}

返回示例

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

错误码

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