You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/观看限制/Version：2023-08-01/删除白名单观看限制中的白名单
删除白名单观看限制中的白名单
最近更新时间：2024.09.06 11:05:52首次发布时间：2024.09.06 11:05:52
我的收藏

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

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 前提条件：调用 UpdateViewingRestriction 接口并将 ViewingAccountType 取值设为 3，将观看限制设置为白名单。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DeleteWhiteList接口名称。当前 API 的名称为 DeleteWhiteList。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是1770****81234直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

PermissionOrder

Integer

是

1

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

  • 1：删除主观看限制中的观众白名单
  • 2：删除次观看限制中的观众白名单

DeleteAll

Integer

是

0

是否删除所有的观众白名单。取值如下：

  • 0：仅删除部分白名单
  • 1：删除所有白名单

DeleteUserList

Array of String

是

["12345","67890"]

待删除的白名单信息列表。白名单信息即观众的邮箱、手机号等信息，长度为 1 到 100 个字符。

说明

该参数仅在 DeleteAll 取值为 0 时生效。

返回参数

参数类型示例值描述
ActivityIdLong1770****81234直播间 ID。

Status

Integer

1

是否成功删除所有指定的观众白名单。取值如下：

  • 1：成功
  • 2：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=DeleteWhiteList&Version=2023-08-01
{
    "ActivityId": 1770****81234,
    "DeleteAll": 0,
    "DeleteUserList": [
        "12345",
        "67890"
    ],
    "PermissionOrder": 1
}

返回示例

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

错误码

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