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

更新房间&用户封禁规则 UpdateBanRoomUserRule

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

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

我的收藏

如果你已经封禁某房间或用户，你可以使用 UpdateBanRoomUserRule 更新已设置的封禁规则。

使用说明

接口行为

你可以调用 UpdateBanRoomUserRule 接口，覆盖此前在 BanRoomUser 中设定的ForbiddenInterval参数，对封禁时长进行更新。
在使用 UpdateBanRoomUserRule 前，你必须已经使用 BanRoomUser 对房间或用户进行了封禁。

调用接口

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

注意事项

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

请求说明

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

请求参数

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

Query

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

返回参数

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

参数
类型
示例值
描述
message
String
success

请求示例

POST https://rtc.volcengineapi.com?Action=UpdateBanRoomUserRule&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "ForbiddenInterval": 0
}

返回示例

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

错误码

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