GetVipOrBlackListUserInfo - 获取优先中奖名单或中奖黑名单用户信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetVipOrBlackListUserInfo - 获取优先中奖名单或中奖黑名单用户信息

最近更新时间：2025.03.24 16:51:00首次发布时间：2025.03.06 11:42:49

调用 GetVipOrBlackListUserInfo，获取直播间内红包中指定优先中奖名单或中奖黑名单的用户信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetVipOrBlackListUserInfo`	接口名称。当前 API 的名称为 `GetVipOrBlackListUserInfo`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`182519****981916`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Id	Long	是	`162****123`	优先中奖名单 ID 或中奖黑名单 ID。您可调用 CreateVipOrBlackListUserInfo 接口，通过返回参数的 `VipUserInfoId` 或 `BlackUserInfoId` 获取 ID。
KeyWord	String	否	`A`	关键词搜索。支持根据 `UserId`（用户 ID）和 `UserName`（昵称）进行搜索。`UserName` 支持模糊搜索，英文区分大小写。
PageNum	Integer	否	`1`	分页查询页码。默认值为 `1`。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。

返回参数

参数	类型	示例值	描述
Role	Integer	`1`	名单类型。取值如下： `1`：优先中奖名单 `2`：中奖黑名单
VipUserInfoId	Long	`162****123`	优先中奖名单 ID。
BlackUserInfoId	Long	`0`	中奖黑名单 ID。
UserCount	Integer	`1`	名单中的用户数量。
AwardUserInfoList	Array of AwardUserInfoList	`-`	用户信息列表。说明企业直播按照以下优先级顺序匹配名单中的观众：`UserId`（用户 ID）、`UserTel`（手机号）、`UserName`（用户昵称）。例如配置了 `UserId`，则无论是否能匹配到观众，均不再按 `UserTel` 或 `UserName` 进行匹配。

AwardUserInfoList

参数	类型	示例值	描述
UserId	String	`172739****031831`	用户 ID。
UserTel	String	`156****1234`	手机号。
UserName	String	`观众 A`	昵称。说明如果在优先中奖名单中仅配置了昵称，且该昵称在当前直播间的观众中并非唯一，则会从昵称相同的观众中随机抽奖。如果在中奖黑名单中仅配置了昵称，且该昵称在当前直播间的观众中并非唯一，则昵称相同的所有观众均无法中奖。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetVipOrBlackListUserInfo&Version=2023-08-01&ActivityId=182519****981916&Id=162****123&KeyWord=A&PageNum=1&PageSize=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetVipOrBlackListUserInfo",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "UserCount": 1,
        "AwardUserInfoList": [
            {
                "UserId": "172739****031831",
                "UserName": "观众 A",
                "UserTel": "156****1234"
            }
        ],
        "VipUserInfoId": 162****123,
        "BlackUserInfoId": 0,
        "Role": 1
    }
}

错误码

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