保利威文档中心

幫助中心

查詢任務獎勵活動分頁列表

更新時間：2026-02-02 16:50:11

介面描述

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

介面URL

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

請求方式

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/page?channelId=4854808&pageSize=10&pageNumber=1&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

回應體json:

{
    "code": 200,
    "status": "success",
    "requestId": "aa9f6d7d-b67b-45de-b5d6-4e0302e4c609",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "activityId": 1519,
                "userId": "cc167950af",
                "channelId": 4990862,
                "activityName": "123",
                "activityMode": 1,
                "taskRule": 2,
                "status": 0,
                "startTime": 1720611960000,
                "endTime": 1720623600000,
                "tasks": [
                    {
                        "taskId": 4827,
                        "sort": 1,
                        "startTime": 1720611960000,
                        "endTime": 1720623600000,
                        "reachCondition": {
                            "type": "sign",
                            "amount": 1
                        },
                        "rewardSetting": {
                            "type": "cash",
                            "amount": 30,
                            "limit": 1,
                            "customReward": ""
                        }
                    }
                ]
            }
        ]
    },
    "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 true Integer 頻道id
activityId true Long 活動id
activityName true String 活動名稱，最大長度64個字元
status true Integer 活動狀態：0：已結束，1：未開始，2：進行中
taskRule false Integer 任務規則：1：解鎖任務，2：並行任務
startTime false Long 活動開始時間
endTime false Long 活動結束時間
tasks false Array 任務規則列表 【詳見tasks欄位說明】

tasks參數描述

參數名 必填 類型 說明
sort true Integer 排序
reachCondition true Object 達成條件設定 【詳見reachCondition】
rewardSetting false Object 獎勵設定

reachCondition參數描述

參數名 必填 類型 說明
type true String 達成條件（sign：簽到，online：線上時長，questionnaire：答題，custom：自訂）
amount true Integer 達成數值
templateId false Long 題目ID，達成條件為questionnaire時必傳
customEvent false String 自訂任務事件，達成條件為custom時必傳
customEventName false String 自訂任務名稱
customIcon false String 自訂任務圖示
customUnit false String 自訂任務單位
customButtonText false String 自訂任務按鈕文案
customReachText false String 自訂任務達成文案，eg: {customEventName}完成：{amount}{customUnit}

rewardSetting參數描述

參數名 必填 類型 說明
type true String cash:現金，custom:自訂，nothing:無獎勵，externalPoint:外部積分
amount true Integer 獎勵數值（type為cash時，現金單位是分）
limit false Integer 獎勵設定
customReward false 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 pageSize = 10;
        Integer pageNumber = 1;
        //业务参数
        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("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": "aa9f6d7d-b67b-45de-b5d6-4e0302e4c609",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 3,
        "contents": [
            {
                "activityId": 1519,
                "userId": "cc167950af",
                "channelId": 4990862,
                "activityName": "123",
                "activityMode": 1,
                "taskRule": 2,
                "status": 0,
                "startTime": 1720611960000,
                "endTime": 1720623600000,
                "tasks": [
                    {
                        "taskId": 4827,
                        "sort": 1,
                        "startTime": 1720611960000,
                        "endTime": 1720623600000,
                        "reachCondition": {
                            "type": "sign",
                            "amount": 1
                        },
                        "rewardSetting": {
                            "type": "cash",
                            "amount": 30,
                            "limit": 1,
                            "customReward": ""
                        }
                    },
                    {
                        "taskId": 4828,
                        "sort": 2,
                        "startTime": 1720611960000,
                        "endTime": 1720623600000,
                        "reachCondition": {
                            "type": "online",
                            "amount": 5
                        },
                        "rewardSetting": {
                            "type": "cash",
                            "amount": 30,
                            "limit": -1,
                            "customReward": ""
                        }
                    }
                ]
            },
            {
                "activityId": 1518,
                "userId": "cc167950af",
                "channelId": 4990862,
                "activityName": "解锁任务",
                "activityMode": 1,
                "taskRule": 1,
                "status": 0,
                "startTime": 1720611300000,
                "endTime": 1720611849000,
                "tasks": [
                    {
                        "taskId": 4824,
                        "sort": 1,
                        "startTime": 1720611300000,
                        "endTime": 1720612800000,
                        "reachCondition": {
                            "type": "sign",
                            "amount": 1
                        },
                        "rewardSetting": {
                            "type": "nothing",
                            "amount": 0,
                            "limit": 0,
                            "customReward": ""
                        }
                    },
                    {
                        "taskId": 4825,
                        "sort": 2,
                        "startTime": 1720611300000,
                        "endTime": 1720612800000,
                        "reachCondition": {
                            "type": "online",
                            "amount": 1
                        },
                        "rewardSetting": {
                            "type": "custom",
                            "amount": 0,
                            "limit": -1,
                            "customReward": "自定义"
                        }
                    },
                    {
                        "taskId": 4826,
                        "sort": 3,
                        "startTime": 1720611300000,
                        "endTime": 1720612800000,
                        "reachCondition": {
                            "type": "online",
                            "amount": 2
                        },
                        "rewardSetting": {
                            "type": "cash",
                            "amount": 30,
                            "limit": 1,
                            "customReward": ""
                        }
                    }
                ]
            },
            {
                "activityId": 1517,
                "userId": "cc167950af",
                "channelId": 4990862,
                "activityName": "英文测试",
                "activityMode": 1,
                "taskRule": 1,
                "status": 0,
                "startTime": 1720608180000,
                "endTime": 1720609200000,
                "tasks": [
                    {
                        "taskId": 4818,
                        "sort": 1,
                        "startTime": 1720608180000,
                        "endTime": 1720609200000,
                        "reachCondition": {
                            "type": "sign",
                            "amount": 1
                        },
                        "rewardSetting": {
                            "type": "nothing",
                            "amount": 0,
                            "limit": 0,
                            "customReward": ""
                        }
                    },
                    {
                        "taskId": 4819,
                        "sort": 2,
                        "startTime": 1720608180000,
                        "endTime": 1720609200000,
                        "reachCondition": {
                            "type": "online",
                            "amount": 1
                        },
                        "rewardSetting": {
                            "type": "custom",
                            "amount": 0,
                            "limit": -1,
                            "customReward": "测试"
                        }
                    },
                    {
                        "taskId": 4820,
                        "sort": 3,
                        "startTime": 1720608180000,
                        "endTime": 1720609200000,
                        "reachCondition": {
                            "type": "online",
                            "amount": 2
                        },
                        "rewardSetting": {
                            "type": "cash",
                            "amount": 30,
                            "limit": -1,
                            "customReward": ""
                        }
                    },
                    {
                        "taskId": 4821,
                        "sort": 4,
                        "startTime": 1720608180000,
                        "endTime": 1720609200000,
                        "reachCondition": {
                            "type": "online",
                            "amount": 3
                        },
                        "rewardSetting": {
                            "type": "cash",
                            "amount": 30,
                            "limit": 1,
                            "customReward": ""
                        }
                    }
                ]
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服，在线咨询