查詢任務獎勵活動統計資料分頁列表

更新時間：2024-07-18 09:28:45

介面說明

1、查询任务奖励活动统计数据分页列表
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/channel/task-reward-activity/stats

請求方式

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
pageSize	false	Integer	頁面大小（預設10，最大1000）
pageNumber	false	Integer	頁碼（目前限制最大值1000頁）

範例

https://api.polyv.net/live/v4/channel/task-reward-activity/stats?channelId=4854808&pageSize=10&pageNumber=1&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

回應體JSON：

{
    "code": 200,
    "status": "success",
    "requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
    "data": 10465,
    "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
activityName	String	活動名稱，最大長度64個字元
taskRule	Integer	任務規則：1：解鎖任務，2：並行任務
startTime	Long	活動開始時間
endTime	Long	活動結束時間
participantTask	Integer	參與任務人數
reachAllTask	Integer	達成所有任務人數
reachAllReward	Integer	領取所有獎勵人數

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 statsTaskRewardTest() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        Integer channelId = 4962905;
        Integer pageSize = 10;
        Integer pageNumber = 1;
        //业务参数
        String url = "https://api.polyv.net/live/v4/channel/task-reward-activity/stats";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", channelId);
        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": "d018fd435ed4468c81592182f652fefb.66.17212083349786049",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 3,
        "contents": [
            {
                "activityId": 36,
                "userId": "2b3ccac944",
                "channelId": 4962905,
                "activityName": "测试任务",
                "activityMode": 1,
                "taskRule": 1,
                "status": 0,
                "startTime": 1719829080000,
                "endTime": 1719829663000,
                "participantTask": 7,
                "reachAllTask": 7,
                "reachAllReward": 7
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}