调用 ListRedPacketRecordAPI 接口，获取直播间内指定红包的参与名单或中奖名单。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListRedPacketRecordAPI | 接口名称。当前 API 的名称为 ListRedPacketRecordAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。 |
SearchType | Integer | 是 |
| 名单类型。取值如下：
|
| RedPacketID | Integer | 是 | 177951****712199 | 红包 ID。您可通过调用 ListRedPacketDataAPI 接口获取 ID。 |
| PageNo | Integer | 否 | 1 | 分页查询页码。默认值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量。默认值为 10。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNo | Integer | 1 | 分页查询页码。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| TotalCount | Integer | 1 | 查询结果总数。 |
| JoinRedPacketList | Array of JoinRedPacketList | - | 名单中的观众信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserID | Long | 173868****584142 | 用户 ID。 |
| UserName | String | 观众 A | 昵称。 |
| String | abc@example.com | 邮箱。 | |
ExternalId | String |
| 关联用户 ID，即观众在第三方平台的唯一标识。
说明 如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 |
| UserTel | String | 152****1234 | 观众登录直播间时使用的手机号。 |
Amount | Integer |
| 观众抢中的红包金额或积分。
|
IsPriorityUser | Integer |
| 是否为优先中奖用户。取值如下：
|
| WithdrawalStatus | String | 0 | 已废弃。 |
| WechatName | String | 小张 | 已废弃。 |
| PhoneNumber | String | 158****1234 | 已废弃。 |
| WechatOpenID | String | HFTOM545 | 已废弃。 |
Status | Integer |
| 中奖状态。取值如下：
|
| Ip | String | 10.5.22.56 | IP 地址。 |
| Extra | String | abc | 业务方扩展字段。 |
| UserAgent | String | Intel Mac OS X 10_15_7 | 终端设备。 |
GET https://livesaas.volcengineapi.com/?Action=ListRedPacketRecordAPI&Version=2020-06-01&ActivityId=182492****234844&SearchType=2&RedPacketID=177951****712199&PageNo=1&PageItemCount=10
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "ListRedPacketRecordAPI",
"Version": "2020-06-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"JoinRedPacketList": [
{
"UserID": 173868****584142,
"Amount": 100,
"WechatOpenID": "HFTOM545",
"UserAgent": "Intel Mac OS X 10_15_7",
"Extra": "abc",
"Ip": "10.5.22.56",
"Status": 1,
"PhoneNumber": "158****1234",
"WechatName": "小张",
"WithdrawalStatus": "0",
"IsPriorityUser": 0,
"UserTel": "152****1234",
"Email": "abc@example.com",
"ExternalId": "160575****530014",
"UserName": "观众 A"
}
],
"PageNo": 1,
"PageItemCount": 10,
"TotalCount": 1
}
}