新增白名单观看限制中的白名单--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

新增白名单观看限制中的白名单

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

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：调用 UpdateViewingRestriction 接口并将 ViewingAccountType 取值设为 3，将观看限制设置为白名单。
使用限制：单个直播间最多支持添加 200,000 条观众白名单，单次接口调用最多支持添加 2100 条观众白名单。

请求说明

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

请求参数

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

Query

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

Body

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

ActivityId Long 是 1770****81234 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770****81234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
PermissionOrder	Integer	是	`1`	主次观看限制类型。取值如下： `1`：添加观众白名单至主观看限制 `2`：添加观众白名单至次观看限制
WhiteListUser	Array of WhiteListUser	是	`-`	待添加的观众白名单列表。

PermissionOrder

Integer

是

1

主次观看限制类型。取值如下：

1：添加观众白名单至主观看限制
2：添加观众白名单至次观看限制

WhiteListUser Array of WhiteListUser 是 - 待添加的观众白名单列表。

WhiteListUser

参数	类型	是否必选	示例值	描述
ExternalUserId	String	是	`12345`	白名单信息，即观众的邮箱、手机号等信息，长度为 1 到 100 个字符。说明重复的白名单信息只会被添加一次。
NickName	String	否	`观众 A`	用户昵称。长度为 1 到 60 个字符。

返回参数

参数	类型	示例值	描述
ActivityId	Long	`1770****81234`	直播间 ID。
ErrorUserList	Array of ErrorUserList	`-`	错误列表。说明仅在一个或多个观众白名单添加失败时有值。

ErrorUserList

参数	类型	示例值	描述
ExternalUserId	String	`12345`	白名单信息。
NickName	String	`观众 A`	用户昵称。
ErrorReason	String	`白名单重复`	错误原因。

请求示例

POST https://livesaas.volcengineapi.com/?Action=InsertWhiteList&Version=2023-08-01
{
    "ActivityId": 1770****81234,
    "PermissionOrder": 1,
    "WhiteListUser": [
        {
            "ExternalUserId": "12345",
            "NickName": "观众 A"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "InsertWhiteList",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1685969459
    },
    "Result": {
        "ActivityId": 1770****81234,
        "ErrorUserList": [
            {
                "ExternalUserId": "",
                "NickName": "",
                "ErrorReason": ""
            }
        ]
    }
}

错误码

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