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

接口行为

你可以调用 UpdateBanRoomUserRule 接口,覆盖此前在 BanRoomUser 中设定的ForbiddenInterval参数,对封禁时长进行更新。

前置条件

在使用 UpdateBanRoomUserRule 前,你必须已经使用 BanRoomUser 对房间或用户进行了封禁。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制

QPS 不得超过 20。

请求方式

使用 Post 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
参数名类型必填示例值描述
ActionString是UpdateBanRoomUserRule接口名称,本接口取值:UpdateBanRoomUserRule
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdString是Your_AppId你的音视频应用的唯一标志
RoomIdString是Your_RoomId指定房间 ID
UserIdString否Your_UserId希望封禁用户的 ID
ForbiddenIntervalInt否0封禁时长,单位为秒,取值范围为[60,259290]。
若传入值为空或 0表示允许用户重新进房。
若传入值大于0,且小于60,自动修改为60。
若传入值大于259290,自动修改为259290。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=UpdateBanRoomUserRule&Version=2020-12-01
Body
{
    "AppId" : "Your_AppId",
    "RoomId" : "Your_RoomId",   
    "UserId" : "Your_UserId",
    "ForbiddenInterval" : 0    
}
json
返回调用结果

返回值 Result 仅在请求成功时返回"ok",失败时为空。

正常返回示例
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UpdateBanRoomUserRule",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "message": "success"
}
json