调用 ListRedPacketDataAPI 接口，获取指定直播间的红包数据，包括参与人数、中奖人数、观众的中奖金额等。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListRedPacketDataAPI | 接口名称。当前 API 的名称为 ListRedPacketDataAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。 |
| PageNo | Integer | 否 | 1 | 分页查询页码。默认值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量。默认值为 10。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNo | Integer | 1 | 分页查询页码。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| TotalCount | Integer | 1 | 查询结果总数。 |
| RedPacketList | Array of RedPacketList | - | 红包列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RedPacketId | Integer | 175447****139760 | 红包 ID。 |
RedPacketType | Integer |
| 红包类型。取值如下：
说明 您可以进行二次开发，按照红包中奖结果，向抢到红包的观众发放积分或让观众完成现金红包提现。详见接入流程。 |
TotalAmount | Integer |
| 红包总金额或总积分。
|
| RewardsPointsUnit | String | 积分 | 积分单位。 |
ReceivedAmount | Integer |
| 观众的中奖金额。
|
| SendTime | Integer | 1673202413 | 红包的发送时间。Unix 时间戳，单位为秒。 |
| JoinUserNumber | Integer | 1 | 参与人数。 |
| WinUserNumber | Integer | 1 | 中奖人数。 |
| WithdrawalAmount | Integer | 100 | 已废弃。 |
| RedPacketNumber | String | 1 | 红包个数。 |
IsDelete | Boolean |
| 红包是否已删除。取值如下：
|
GET https://livesaas.volcengineapi.com/?Action=ListRedPacketDataAPI&Version=2020-06-01&ActivityId=182492****234844&PageNo=1&PageItemCount=10
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListRedPacketDataAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "RedPacketList": [ { "RedPacketType": 0, "RewardsPointsUnit": "积分", "TotalAmount": 10000, "RedPacketId": 175447****139760, "RedPacketNumber": "1", "WithdrawalAmount": 100, "WinUserNumber": 1, "JoinUserNumber": 1, "SendTime": 1673202413, "ReceivedAmount": 100, "IsDelete": false } ], "PageNo": 1, "PageItemCount": 10, "TotalCount": 1 } }