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

文档中心

立即注册

导航

企业直播

新增手机号观看限制中的白名单手机号

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

当指定直播间的观看限制被设置为手机号且开启白名单模式功能时，您可通过此接口添加手机号。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：调用 UpdateViewingRestriction 接口，将 ViewingAccountType 和 IsPhoneListMode 的取值分别设置为 5 和 true，将观看限制设置为手机号并开启白名单模式功能。
使用限制：单个直播间最多支持添加 200,000 条手机号，单次接口调用最多支持添加 2000 条手机号。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`InsertPhoneList`	接口名称。当前 API 的名称为 `InsertPhoneList`。
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`：添加手机号至次观看限制
PhoneList	Array of String	是	`["156**1234","137**1234"]`	待添加的手机号列表。说明海外手机号请遵循以下格式：“+” + 国际电话区号 + 手机号，例如 +1XXXXXXXXXX 表示北美手机号。重复的手机号只会被添加一次。

PermissionOrder

Integer

是

1

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

1：添加手机号至主观看限制
2：添加手机号至次观看限制

PhoneList

Array of String

是

["156****1234","137****1234"]

待添加的手机号列表。

说明

海外手机号请遵循以下格式：“+” + 国际电话区号 + 手机号，例如 +1XXXXXXXXXX 表示北美手机号。
重复的手机号只会被添加一次。

返回参数

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

ErrorPhoneList

参数	类型	示例值	描述
ErrorPhone	String	`156****1234`	添加失败的手机号。
ErrorReason	String	`手机号已存在`	错误原因。

请求示例

POST https://livesaas.volcengineapi.com/?Action=InsertPhoneList&Version=2023-08-01
{
    "ActivityId": 1770****81234,
    "PermissionOrder": 1,
    "Phonelist": [
        "156****1234",
        "137****1234"
    ]
}

返回示例

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

错误码

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