实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考房间管理封禁房间&用户 BanRoomUser
复制全文
下载 pdf封禁房间&用户 BanRoomUser
文档反馈
问问助手调用 BanRoomUser 接口，将指定用户移出单个或所有房间，或解散整个房间。支持设置禁止进房时长，阻止违规用户在规定时间内再次进入房间。
说明
只要有用户在 RTC 房间（包括后端服务机器人），就会至少计算该用户的音频计费时长。为避免产生不必要的费用，你可通过 BanRoomUser解散房间来确保所有用户退出房间。
使用说明
- 通过指定 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 不得超过 40。
请求说明
- 请求方式：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
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": "66****3cf",
"RoomId": "Room1",
"UserId": "user1",
"ForbiddenInterval": 0
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "BanRoomUser",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"Message": "success"
}
}
错误码
最近更新时间：2026.03.13 10:26:43
这个页面对您有帮助吗？
有用
有用
无用
无用