封禁房间&用户 BanRoomUser--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

封禁房间&用户 BanRoomUser

最近更新时间：2024.08.19 17:35:53首次发布时间：2024.01.03 20:25:19

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

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

通过指定 AppId 和 RoomId，你可封禁指定房间。此时若 ForbiddenInterval 为空或 0，则将房间内所有用户踢出该房间，但允许用户立刻重新进入该房间。若 ForbiddenInterval 大于0，则将所有用户踢出该房间，且该规定时间内不允许任何用户重新进入该房间。
通过指定 AppId、RoomId 和 UserId，你可封禁指定房间内该 UserId 对应的用户。此时若 ForbiddenInterval 为空或 0，则将该用户踢出指定房间，但允许用户立刻重新进入该房间。若 ForbiddenInterval 大于0，则将该用户踢出房间，且该规定时间内不允许该用户重新进入该房间。
通过指定 AppId 和 UserId，你可以封禁所有房间内的该 UserId 对应的用户。此时若 ForbiddenInterval 为空或 0，则将 UserId 对应的所有用户踢出房间，但允许用户立刻重新进入房间。若 ForbiddenInterval 大于0，则将 UserId 对应的所有用户踢出房间，且该规定时间内不允许 UserId 对应的所有用户重新进入房间。

操作完成后，被移出用户会收到 -1006 的错误码，如果被移出用户是可见用户，房间中其他用户会收到 onUserLeave 回调。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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`	封禁时长，取值范围为 `{0,[10,604800]}`，单位为秒。若传入值为空或 `0` 表示允许用户重新进房。若传入值小于 `10`，自动修改为 `10`。若传入值大于 `604800`，自动修改为 `604800`。

返回参数

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

参数	类型	示例值	描述
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"
    }
}

错误码

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