调用 UpdateActivityUserBanStatus 接口，在指定直播间内封禁、踢出或解除封禁一个或多个观众或设备。被封禁的观众和设备无法进入或继续停留在该直播间，但被踢出的观众和设备可重新进入该直播间。

使用说明

接口行为

调用该接口，您可以在指定直播间内完成以下操作：

• 封禁一个或多个观众或设备：将 BanType 取值设置为 0，BanStatus 取值设置为 1，并至少传入 UserIds 和 Cookies 其中之一。
  • 仅传入 UserIds 时，封禁指定用户 ID 的观众。
  • 仅传入 Cookies 时，封禁指定 ID 的设备。
  • 同时传入 UserIds 和 Cookies 时，封禁指定用户 ID 的观众以及指定 ID 的设备。
• 解除封禁一个或多个观众或设备：将 BanType 取值设置为 0，BanStatus 取值设置为 0，并至少传入 UserIds 和 Cookies 其中之一。
  • 仅传入 UserIds 时，解除封禁指定用户 ID 的观众。
  • 仅传入 Cookies 时，解除封禁指定 ID 的设备。
  • 同时传入 UserIds 和 Cookies 时，解除封禁指定用户 ID 的观众以及指定 ID 的设备。
• 将一个或多个观众或设备踢出直播间：将 BanType 取值设置为 1，并至少传入 UserIds 和 Cookies 其中之一。
  • 仅传入 UserIds 时，将指定用户 ID 的观众踢出直播间。
  • 仅传入 Cookies 时，将指定 ID 的设备踢出直播间。
  • 同时传入 UserIds 和 Cookies 时，将指定用户 ID 的观众以及指定 ID 的设备踢出直播间。

注意事项

• 请求频率：单用户请求频率限制为 30 次/秒。
• 使用限制：单个直播间中，被封禁的观众人数上限为 50,000，被封禁的设备数量上限为 50,000。单次接口调用最多支持对 50 个观众和 50 个设备执行封禁、踢出或解除封禁操作。
• 前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

调试

请求参数

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

Query

Body

返回参数

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityUserBanStatus&Version=2023-08-01
{
    "ActivityId": 181917****140099,
    "BanStatus": 1,
    "UserIds": [
        182021****043371,
        182021****043372,
        182021****043373
    ],
    "Cookies": [
        "123",
        "345"
    ],
    "BanType": 0,
    "ExternalUserIds": [
        "1482148456"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityUserBanStatus",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1735982834
    },
    "Result": {
        "Status": true
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。