调用 GetTaskAwardRecordStatisticsAPI 接口,获取指定直播间指定累计观看抽奖的参与观众名单或中奖观众名单。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetTaskAwardRecordStatisticsAPI | 接口名称。当前 API 的名称为 GetTaskAwardRecordStatisticsAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| PageNo | Integer | 否 | 1 | 分页查询页码,默认取值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量。取值范围为 [1,500],默认取值为 10。 |
| TaskAwardItemId | String | 是 | 6188 | 累计观看抽奖的奖品 ID。您可以通过调用 GetTaskAwardItemListAPI接口查询 ID |
SearchType | Integer | 否 |
| 查询的观众名单类型,默认取值为
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TaskAwardRecordList | Array of TaskAwardRecordList | - | 累计观看抽奖的观众信息列表。 |
| PageNo | Integer | 1 | 分页查询页码.。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| PageTotalCount | Integer | 1 | 查询结果总数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserId | Long | 1753988749721692 | 观众 ID。 |
| Phone | String | 158xxxx66 | 观众的登录手机号。 |
| String | zhibo@xxx.com | 观众注册账号时,填写的邮箱地址。 | |
| Nickname | String | cjr | 观众昵称。 |
| Address | String | 北京 | 收货地址。 |
Status | Integer |
| 中奖状态。支持以下取值:
|
| ExternalId | String | 1437224142 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计。 |
| LoginTel | String | 158xxxx66 | 观众的登录手机号。 |
| ReceiverName | String | 张三 | 收件人姓名。 |
| TaskAwardName | String | 幸运奖 | 奖品名称。 |
| WinTime | String | 1437224456142 | 开奖时间,Unix 时间戳,单位为秒。 |
| Ip | String | 10.255.21.200 | 观众的 IP 地址。 |
| Extra | String | abc | 业务方扩展字段。 |
| UserAgent | String | Intel Mac OS X 10_15_7 | 观众进入直播间使用的终端机型。 |
| AwardEmail | String | winner@example.com | 观众中奖后,填写的邮箱地址。 |
GET https://livesaas.volcengineapi.com/?Action=GetTaskAwardRecordStatisticsAPI&Version=2020-06-01&ActivityId=17791682871582&PageNo=1&PageItemCount=10&TaskAwardItemId=6188&SearchType=2
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetTaskAwardRecordStatisticsAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "TaskAwardRecordList": [ { "UserId": 1753988749721692, "Phone": "158xxxx66", "Email": "zhibo@xxx.com", "Nickname": "cjr", "Address": "北京", "Status": 2, "ExternalId": "1437224142", "LoginTel": "158xxxx66", "ReceiverName": "张三", "TaskAwardName": "幸运奖", "WinTime": "1437224456142", "Ip": "10.255.21.200", "Extra": "abc", "UserAgent": "Intel Mac OS X 10_15_7", "AwardEmail": "winner@example.com" } ], "PageNo": 1, "PageItemCount": 10, "PageTotalCount": 1 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
| 500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |