获取直播间红包的参与观众名单或中奖观众名单。
请求频率:单用户请求频率限制为 120 次/分钟。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListRedPacketRecordAPI | 接口名称。当前 API 的名称为 ListRedPacketRecordAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
ActivityId | Long | 是 | 1231231231 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。 |
PageNo | Integer | 否 | 1 | 分页查询页码,默认取值为 1 。 |
PageItemCount | Integer | 否 | 10 | 分页查询数量,默认取值为 10 。 |
SearchType | Integer | 是 |
| 查询的名单类型。
|
RedPacketID | Integer | 是 | 1779513713712199 | 红包 ID。您可以通过调用 ListRedPacketDataAPI 接口查询 ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
JoinRedPacketList | Array of JoinRedPacketList | - | 观众信息列表。 |
PageNo | Integer | 1 | 分页查询页码。 |
PageItemCount | Integer | 10 | 分页查询数量。 |
TotalCount | Integer | 1 | 查询结果总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserID | Long | 1738686737584142 | 观众 ID。 |
ExternalId | String | 1605756488530014 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计。 |
UserName | String | aa1 | 观众昵称。 |
String | zhibo@xxx.com | 观众邮箱。 | |
UserTel | String | 152***364 | 观众登录手机号。 |
Amount | Integer |
| 观众抢中的现金红包或积分红包金额。
|
IsPriorityUser | Integer |
| 观众是否为优先中奖用户。
|
WithdrawalStatus | String |
| 提现状态。
说明 该参数仅在查询中奖名单时返回。 |
WechatName | String |
| 观众授权提现至微信零钱的微信昵称。 说明 该参数仅在查询中奖名单时返回。 |
PhoneNumber | String | 158xxxx88 | 观众提现手机号。 |
WechatOpenID | String |
| 观众授权提现至微信零钱的微信用户 OpenID。 说明 该参数仅在查询中奖名单时返回。 |
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=1231231231&PageItemCount=10&PageNo=1&RedPacketID=1779513713712199&SearchType=2
{ "ResponseMetadata": { "RequestId": "202301131353233BE8AB68A85AE0CB0316", "Action": "ListRedPacketRecordAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1673589203 }, "Result": { "PageNo": 1, "PageItemCount": 10, "TotalCount": 1, "JoinRedPacketList": [ { "UserID": 1738686737584142, "UserName": "aa1", "Email": "zhibo@xxx.com", "PhoneNumber": "158xxxx88", "Status": 1, "ExternalId": "1605756488530014", "Amount": 100, "WithdrawalStatus": 0, "WechatName": "小张", "WechatOpenID": "HFTOM545", "Ip": "10.5.22.56", "Extra": "abc", "UserAgent": "Intel Mac OS X 10_15_7", "UserTel": "152***364", "IsPriorityUser": 0 } ] } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |