GetWhiteList - 获取白名单观看限制中的白名单列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetWhiteList - 获取白名单观看限制中的白名单列表

最近更新时间：2025.03.24 16:50:58首次发布时间：2024.09.06 11:05:52

当指定直播间的观看限制被设置为白名单时，您可通过此接口获取已添加的观众白名单列表。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：
- 确保您拥有火山引擎主账号或具备直播间的观看页管理 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
- 调用 UpdateViewingRestriction 接口并将 ViewingAccountType 取值设为 3，将观看限制设置为白名单。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetWhiteList`	接口名称。当前 API 的名称为 `GetWhiteList`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1770****81234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PermissionOrder	Integer	是	`1`	主次观看限制类型。取值如下： `1`：获取主观看限制中的观众白名单列表 `2`：获取次观看限制中的观众白名单列表
PageNum	Integer	否	`1`	分页查询页码。默认值为 `1`。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`，取值范围为 [1,500]。
KeyWord	String	否	`A`	根据白名单信息或用户昵称进行筛选。支持模糊搜索，大小写不敏感。例如，该参数取值为 `A`，则返回白名单信息为 `123a`、用户昵称为`观众 A` 等包含关键词 `A` 的观众白名单。

返回参数

参数	类型	示例值	描述
ActivityId	Long	`1770****81234`	直播间 ID。
WhiteList	Array of WhiteList	`-`	观众白名单列表。

WhiteList

参数	类型	示例值	描述
ExternalUserId	String	`12345`	白名单信息。
NickName	String	`观众 A`	用户昵称。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetWhiteList&Version=2023-08-01&ActivityId=1770****81234&PermissionOrder=1&PageNum=1&PageSize=10&KeyWord=A

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetWhiteList",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ActivityId": 1770****81234,
        "WhiteList": [
            {
                "NickName": "观众 A",
                "ExternalUserId": "12345"
            }
        ]
    }
}

错误码

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