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

文档中心

立即注册

导航

企业直播

DeletePhoneList - 删除手机号观看限制中的白名单手机号

最近更新时间：2025.06.26 21:12:09首次发布时间：2024.09.06 11:05:53

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770****81234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PermissionOrder	Integer	是	`1`	主次观看限制类型。取值如下： `1`：删除主观看限制中的手机号 `2`：删除次观看限制中的手机号
DeleteAll	Integer	是	`0`	是否删除所有的手机号。取值如下： `0`：仅删除部分手机号 `1`：删除所有手机号
DeletePhoneList	Array of String	是	`["156**1234","137**1234"]`	待删除的手机号列表。说明该参数仅在 `DeleteAll` 取值为 `0` 时生效。海外地区和中国香港、中国澳门、中国台湾地区的手机号请遵循以下格式：“+” + 国际电话区号 + 手机号，例如 +1XXXXXXXXXX 表示北美手机号。

返回参数

参数类型示例值描述

ActivityId Long 1770****81234 直播间 ID。

参数	类型	示例值	描述
ActivityId	Long	`1770****81234`	直播间 ID。
Status	Integer	`1`	是否成功删除所有指定的手机号。取值如下： `1`：成功 `2`：失败

Status

Integer

1

是否成功删除所有指定的手机号。取值如下：

1：成功
2：失败

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DeletePhoneList",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ActivityId": 1770****81234,
        "Status": 1
    }
}

错误码

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