账号维度封禁或解禁观众--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

账号维度封禁或解禁观众

最近更新时间：2024.09.09 18:51:57首次发布时间：2024.09.09 18:51:57

您可通过此接口根据用户 ID 封禁或解禁一个或多个观众。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
使用限制：单次接口调用最多支持封禁或解禁 100 个观众。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateAccountBanStatus&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateAccountBanStatus`	接口名称。当前 API 的名称为 `UpdateAccountBanStatus`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数类型是否必选示例值描述

UserIds Array of Long 是 [12345,67890] 待封禁或解禁的观众用户 ID。您可通过调用 ListAccountUserData 接口获取用户 ID。

参数	类型	是否必选	示例值	描述
UserIds	Array of Long	是	`[12345,67890]`	待封禁或解禁的观众用户 ID。您可通过调用 ListAccountUserData 接口获取用户 ID。
BanStatus	Integer	是	`1`	封禁或解禁观众。取值如下： `1`：封禁。观众被封禁后，无法进入当前主账号及其子账号的任一直播间。 `2`：解禁。

BanStatus

Integer

是

1

封禁或解禁观众。取值如下：

1：封禁。观众被封禁后，无法进入当前主账号及其子账号的任一直播间。
2：解禁。

返回参数

参数	类型	示例值	描述
FailedUserIds	Array of Long	`[]`	封禁或解禁失败的观众用户 ID。如果所有指定观众均封禁或解禁成功，则为空。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateAccountBanStatus&Version=2023-08-01
{
    "UserIds": [
        12345,
        67890
    ],
    "BanStatus": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateAccountBanStatus",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1721111109
    },
    "Result": {
        "FailedUserIds": []
    }
}

错误码

访问公共错误码和错误码获取详细信息。