查詢任務獎勵活動觀眾獎勵明細分頁列表
更新時間: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
}
