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

文档中心

立即注册

导航

企业直播

获取直播间被踢出的观众和设备列表

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

调用 GetActivityBanUsers 接口，获取指定直播间内被踢出的观众 ID 和设备 ID 列表。被踢出的观众和设备将无法再次进入该直播间。

注意事项

请求频率：单用户请求频率限制为 30 次/秒。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityBanUsers`	接口名称。当前 API 的名称为 `GetActivityBanUsers`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`177985****487296`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

参数	类型	示例值	描述
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

返回示例

{
    "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"
        ]
    }
}

错误码

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