You need to enable JavaScript to run this app.
导航
更新房间&用户封禁规则 UpdateBanRoomUserRule
最近更新时间:2024.06.20 15:25:20首次发布时间:2024.01.03 20:25:18

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

在实时音视频通话场景中,若需对已封禁的房间或用户进行规则调整,你可以通过调用此接口实现。

通过指定应用标识、房间ID、用户ID(可选)以及封禁时长,你可以更新封禁时长。调用后,接口将返回操作结果,包括消息确认,以便你验证规则是否成功更新。

注意事项

请求频率:QPS 不得超过 20

请求说明

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

调试

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
UpdateBanRoomUserRule
接口名称。当前 API 的名称为 UpdateBanRoomUserRule
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,259290],单位为秒。
若传入值为空或 0 表示允许用户重新进房。
若传入值大于 0,且小于 60,自动修改为 60
若传入值大于 259290,自动修改为 259290

返回参数

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

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

请求示例

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

返回示例

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

错误码

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