您可通过此接口获取指定直播间中指定实时抽奖的参与观众名单或中奖观众名单。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListAwardRecordStatistics | 接口名称。当前 API 的名称为 ListAwardRecordStatistics。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| ActivityId | Long | 是 | 1754721774775307 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
SearchType | Integer | 否 |
| 观众名单类型。支持以下取值，默认取值为
|
| AwardId | Long | 是 | 1621615169 | 抽奖 ID。您可以通过 ListAwardConfigs 接口查询 ID（即返回参数 Id）。 |
| PageNo | Integer | 否 | 1 | 分页查询页码，默认取值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量。取值范围为 [1,500]，默认取值为 10。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNo | Integer | 1 | 分页查询页码。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| PageTotalCount | Integer | 1 | 查询结果总数。 |
| AwardRecords | Array of AwardRecords | - | 观众信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ActivityId | Integer | 1754721774775307 | 直播间 ID。 |
| UserName | String | 观众 A | 观众昵称。 |
| LoginTel | String | 157xxxx66 | 观众的登录手机号。 |
| AwardAddress | String | 北京 | 收件人地址。 |
AwardResult | Integer |
| 抽奖结果。支持以下取值：
|
NotifyResult | Integer |
| 观众填写中奖信息后，是否通知抽奖结果，支持以下取值：
|
| ExternalId | String | 1437224142 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。 |
| AwardName | String | 抽奖活动 | 抽奖名称。 |
| ReceiverName | String | 李 | 收件人姓名。 |
| ReceiverTel | String | 157xxxx66 | 收件人手机号。 |
| String | zhibo@xxx.com | 收件人邮箱。 | |
| OpenAwardTime | Integer | 1673535761 | 开奖时间。Unix 时间戳，单位为秒。 |
| Extra | String | abc | 业务方扩展字段。 |
| UserAgent | String | Intel Mac OS X 10_15_7 | 观众进入直播间使用的终端机型。 |
| Ip | String | fdbd:dc00:5ea1:2c6::a4:adb7 | 观众的 IP 地址。 |
IsPriorityUser | Integer |
| 是否为优先中奖人员。支持以下取值：
|
| AwardId | Long | 1621615169 | 抽奖 ID。 |
| UserId | String | 1753988749721692 | 观众 ID，即观众在企业直播的唯一标识。 |
| AwardItemName | String | 奖券奖品 | 中奖的奖品名称。 |
GET https://livesaas.volcengineapi.com/?Action=ListAwardRecordStatistics&Version=2023-08-01&ActivityId=1754721774775307&SearchType=1&AwardID=1621615169&PageNo=1&PageItemCount=10
{ "ResponseMetadata": { "RequestId": "202306041104200100100232280022D31", "Action": "ListAwardRecordStatistics", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1679035761 }, "Result": { "AwardStatisticsList": [ { "ActivityId": 1754721774775307, "UserName": "观众 A", "LoginTel": "157xxxx66", "AwardAddress": "北京", "AwardResult": 4, "NotifyResult": 1, "ExternalId": "1437224142", "AwardName": "抽奖活动", "ReceiverName": "李", "ReceiverTel": "157xxxx66", "Email": "zhibo@xxx.com", "OpenAwardTime": 1673535761, "Extra": "abc", "UserAgent": "Intel Mac OS X 10_15_7", "Ip": "fdbd:dc00:5ea1:2c6::a4:adb7", "IsPriorityUser": 1, "AwardId": 1621615169, "UserId": "1753988749721692", "AwardItemName": "奖券奖品" } ], "PageNo": 1, "PageItemCount": 10, "PageTotalCount": 1 } }