Query Task Reward Activity Paginated List
Updated: 2026-02-02 16:50:11
API Description
1、查询任务奖励活动分页列表
2、接口支持https协议
API URL
https://api.polyv.net/live/v4/channel/task-reward-activity/page
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details on obtaining the secret key |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid for 3 minutes |
| sign | true | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server to obtain response data. See signature generation rules |
| channelId | true | Integer | Channel ID |
| pageSize | false | Integer | Page size (default 10, maximum 1000) |
| pageNumber | false | Integer | Page number (currently limited to a maximum of 1000 pages) |
Example
https://api.polyv.net/live/v4/channel/task-reward-activity/page?channelId=4854808&pageSize=10&pageNumber=1&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318
Response body 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
}
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code, 200 for success, non-200 for failure |
| status | String | Response result, determined by business logic, returns success on success, error on failure |
| success | Boolean | Response result, determined by business logic, returns true on success, false on failure |
| data | Object | Task reward activity paginated data See Data field description |
| error | Object | Error information when status code is non-200 See Error field description |
| requestId | String | Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, should not be tied to business logic |
Data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| pageNumber | Integer | Page number |
| pageSize | String | Page size |
| totalPages | Boolean | Total number of pages |
| totalItems | Object | Total number of records |
| contents | Array | Activity data list See Contents field description |
Contents Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| channelId | true | Integer | Channel ID |
| activityId | true | Long | Activity ID |
| activityName | true | String | Activity name, maximum length 64 characters |
| status | true | Integer | Activity status: 0: Ended, 1: Not started, 2: In progress |
| taskRule | false | Integer | Task rule: 1: Unlock tasks, 2: Parallel tasks |
| startTime | false | Long | Activity start time |
| endTime | false | Long | Activity end time |
| tasks | false | Array | Task rule list See tasks field description |
Tasks Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| sort | true | Integer | Sort order |
| reachCondition | true | Object | Condition settings for completion See reachCondition |
| rewardSetting | false | Object | Reward settings |
ReachCondition Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| type | true | String | Completion condition (sign: Check-in, online: Online duration, questionnaire: Quiz, custom: Custom) |
| amount | true | Integer | Completion value |
| templateId | false | Long | Question ID, required when completion condition is questionnaire |
| customEvent | false | String | Custom task event, required when completion condition is custom |
| customEventName | false | String | Custom task name |
| customIcon | false | String | Custom task icon |
| customUnit | false | String | Custom task unit |
| customButtonText | false | String | Custom task button text |
| customReachText | false | String | Custom task completion text, e.g., {customEventName} completed: {amount}{customUnit} |
RewardSetting Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| type | true | String | cash: Cash, custom: Custom, nothing: No reward, externalPoint: External points |
| amount | true | Integer | Reward value (when type is cash, the unit is cents) |
| limit | false | Integer | Reward setting |
| customReward | false | String | Custom reward, optional |
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to identify the specific error reason |
| desc | String | Error description, corresponds to error.code |
Java Request Example
For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.
It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.
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
}
Response Example
For global system error descriptions, see Global Error Description
Success Example
{
"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
}
Error Example
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
