查询任务奖励活动观众奖励明细分页列表
更新时间:2025-09-25 11:46:33
接口描述
1、查询任务奖励活动观众奖励明细分页列表
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/channel/task-reward-activity/viewer-detail
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | Integer | 频道id |
| activityId | true | Long | 活动id |
| viewerId | false | String | 观众id |
| pageSize | false | Integer | 页面大小(默认10,最大1000) |
| pageNumber | false | Integer | 页码(目前限制最大值1000页) |
示例
https://api.polyv.net/live/v4/channel/task-reward-activity/viewer-detail?channelId=4854808&activityId=1143&viewerId=&pageSize=10&pageNumber=1&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318
响应体json:
{
"code": 200,
"status": "success",
"requestId": "2b023f32-c893-40af-bc13-6e721d516d91",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 2,
"contents": [
{
"viewerId": 1718673362881,
"taskId": 4826,
"sort": 3,
"taskReach": {
"type": "online",
"amount": 2
},
"taskReward": {
"type": "cash",
"amount": "300",
"limit": 1,
"customReward": ""
},
"taskStatus": 1,
"rewardStatus": 3,
"finishTime": 1720611430000
}
]
},
"success": true
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 观众任务奖励明细【详见Data字段说明】 |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | Integer | 页码 |
| pageSize | String | 分页大小 |
| totalPages | Boolean | 总分页数量 |
| totalItems | Object | 总记录数 |
| contents | Array | 活动数据列表【详见Contents字段说明】 |
contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | Integer | 频道id |
| activityId | Long | 活动id |
| viewerId | String | 观众id |
| taskId | Integer | 任务id |
| sort | Long | 排序 |
| taskStatus | Long | 达成状态(0:未达成,1:已达成) |
| rewardStatus | Long | 奖励发放状态(-1:无需发放,0:待发放,1:已发放,2:名额已满,3:发放失败,4:发放中) |
| finishTime | Long | 达成时间 |
| taskReach | Object | 达成条件 【详见taskReach字段说明】 |
| taskReward | Object | 奖励数据 【详见taskReward字段说明】 |
taskReach参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | 达成条件(sign:签到,online:在线时长) |
| amount | Integer | 达成数值 |
taskReward参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| type | String | cash:现金,custom:自定义,nothing:无奖励,externalPoint:外部积分 |
| amount | Integer | 奖励数值(type为cash时,现金单位是分) |
| limit | Integer | 奖励限制份额 |
| customReward | String | 自定义奖励,非必填 |
error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询任务奖励活动观众奖励明细分页列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void pageTaskRewardTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
Integer channelId = 4990862;
Integer activityId = 1134;
Integer pageNumber = 1;
Integer pageSize = 10;
//业务参数
String url = "https://api.polyv.net/live/v4/channel/task-reward-activity/page";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("activityId", activityId);
requestMap.put("pageSize", pageSize);
requestMap.put("pageNumber", pageNumber);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询任务奖励活动观众奖励明细分页列表成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "2b023f32-c893-40af-bc13-6e721d516d91",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 2,
"contents": [
{
"viewerId": 1718673362881,
"taskId": 4826,
"sort": 3,
"taskReach": {
"type": "online",
"amount": 2
},
"taskReward": {
"type": "cash",
"amount": "300",
"limit": 1,
"customReward": ""
},
"taskStatus": 1,
"rewardStatus": 3,
"finishTime": 1720611430000
}
]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
