GetActivityBanUsers - 获取直播间被封禁的观众和设备列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetActivityBanUsers - 获取直播间被封禁的观众和设备列表

最近更新时间：2025.07.03 16:06:25首次发布时间：2025.01.24 10:43:12

调用 GetActivityBanUsers 接口，获取指定直播间内被封禁的观众 ID 和设备 ID 列表。被封禁的观众无法进入或继续停留在当前直播间。

注意事项

请求频率：单用户请求频率限制为 30 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityBanUsers`	接口名称。当前 API 的名称为 `GetActivityBanUsers`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`177985****487296`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PageNo	Integer	否	`1`	分页查询页码，从 `1` 开始计数，默认值为 `1`。该参数分别作用于返回参数 `UserIds` 和 `Cookies`，两个列表均根据此页码进行分页查询。例如，参数值设为 `2` 时，返回的 `UserIds` 和 `Cookies` 均为第 2 页的数据。
PageItemCount	Integer	否	`1000`	分页查询数量，取值范围为 [1,1000]，默认值为 `1000`。该参数分别作用于返回参数 `UserIds` 和 `Cookies`，两个列表均按此数量进行分页查询。例如，参数值设为 `500` 时，返回的 `UserIds` 和 `Cookies` 每页最多包含 500 条数据。

返回参数

参数	类型	示例值	描述
UserIds	Array of Long	`[182021**043371,182021043372,182020**043373]`	被封禁的观众 ID 列表。
Cookies	Array of String	`["123","345"]`	被封禁的设备 ID 列表。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityBanUsers&Version=2023-08-01&ActivityId=177985****487296&PageNo=1&PageItemCount=1000

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityBanUsers",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "UserIds": [
            182021****043371,
            182021****043372,
            182020****043373
        ],
        "Cookies": [
            "123",
            "345"
        ]
    }
}

错误码

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