最近更新时间:2023.02.09 16:20:22
首次发布时间:2023.02.01 14:10:46
获取直播间累计观看抽奖的参与观众名单或中奖观众名单。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称 |
Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01 |
ActivityId | Int | 是 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID |
PageNo | Int | 否 | 分页查询页码,默认取值为 1 |
PageItemCount | Int | 否 | 分页查询数量,默认取值为 10 |
TaskAwardItemId | String | 是 | 累计观看抽奖的奖品 ID。您可以通过调用 GetTaskAwardItemListAPI 接口查询 ID |
SearchType | Int | 否 | 查询的观众名单类型,默认取值为
|
参数 | 类型 | 描述 |
---|---|---|
TaskAwardRecoudList | Array of TaskAwardRecord | 累计观看抽奖的观众信息列表 |
PageNo | Int | 分页查询页码 |
PageItemCount | Int | 分页查询数量 |
PageTotalCount | Int | 查询结果总数 |
参数 | 类型 | 描述 |
---|---|---|
UserId | Int | 观众 ID |
Phone | String | 观众手机号 |
String | 观众邮箱 | |
Nickname | String | 观众昵称 |
Address | String | 收货地址 |
Status | Int | 中奖状态
|
ExternalId | String | 关联用户 ID |
LoginTel | String | 观众的登录手机号 |
ReceiverName | String | 收件人姓名 |
TaskAwardName | String | 奖品名称 |
WinTime | String | 中奖用户开奖时间,Unix 时间戳,单位为秒 |
Ip | String | 观众的 IP 地址 |
Extra | String | 业务方扩展字段 |
UserAgent | String | 观众终端设备 |
Get http://livesaas.volcengineapi.com/?Action=GetTaskAwardRecordStatisticsAPI&Version=2020-06-01&ActivityId=175472177775307&TaskAwardItemId=8480
{ "ResponseMetadata": { "RequestId": "202301151445086753F5AA91AA70249144", "Action": "GetTaskAwardRecordStatisticsAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1673765108 }, "Result": { "PageNo": 1, "PageItemCount": 10, "PageTotalCount": 1, "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" } ] } }
{ "ResponseMetadata": { "RequestId": "2023010901154861C57537B04A4A16B7C1", "Action": "GetTaskAwardRecordStatisticsAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "Error": { "Code": "InvalidParameter.ActivityIdNotFound", "Message": "The specified parameter ActivityId is invalid." }, "SystemTime": 1673198148 }, "Result": null }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |