观众查询奖励明细分页列表

接口描述

1、观众查询奖励明细分页列表
2、接口支持https协议

接口URL

https://api.polyv.net/live/v4/user/viewer-task-reward/page

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

示例

https://api.polyv.net/live/v4/user/viewer-task-reward/page?viewerId=123&pageSize=10&pageNumber=1&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

响应体json:

{
    "code": 200,
    "status": "success",
    "requestId": "c2318da1-7dec-417a-9be4-25980b6372eb",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 6,
        "contents": [
            {
                "id": 1693913,
                "viewerId": "2_844u9odbkqq8eum0rpotqbexwqlio6pq",
                "taskId": 10550,
                "sort": 1,
                "taskReach": {
                    "type": "online",
                    "amount": 1,
                    "questionnaireId": null,
                    "customEvent": null,
                    "customEventName": null,
                    "customIcon": null,
                    "customUnit": null,
                    "customButtonText": null,
                    "customReachText": "{customEventName}{amount}{customUnit}"
                },
                "taskReward": {
                    "type": "cash",
                    "amount": "0.3",
                    "limit": -1,
                    "customReward": ""
                },
                "acceptInfo": {
                    "activeAcceptEnabled": "Y",
                    "acceptType": "form",
                    "received": "N",
                    "formInfo": {
                        "field": "姓名",
                        "tips": "请输入您的名称",
                        "type": "userName",
                        "required": true
                    },
                    "prizeUrl": null,
                    "qrCode": null,
                    "qrCodeTips": null
                },
                "taskStatus": 1,
                "rewardStatus": 1,
                "finishTime": 1742284276000,
                "outTradeErrCode": null,
                "outTradeErrDesc": null,
                "participated": true
            }
        ]
    },
    "success": true
}

响应参数描述

data参数描述

contents参数描述

taskReach参数描述

taskReward参数描述

acceptInfo参数描述

formInfo参数描述

error参数描述

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());
        String viewerId = "123";
        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("viewerId", viewerId);
        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": "c2318da1-7dec-417a-9be4-25980b6372eb",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 6,
        "contents": [
            {
                "id": 1693913,
                "viewerId": "2_844u9odbkqq8eum0rpotqbexwqlio6pq",
                "taskId": 10550,
                "sort": 1,
                "taskReach": {
                    "type": "online",
                    "amount": 1,
                    "questionnaireId": null,
                    "customEvent": null,
                    "customEventName": null,
                    "customIcon": null,
                    "customUnit": null,
                    "customButtonText": null,
                    "customReachText": "{customEventName}{amount}{customUnit}"
                },
                "taskReward": {
                    "type": "cash",
                    "amount": "0.3",
                    "limit": -1,
                    "customReward": ""
                },
                "acceptInfo": {
                    "activeAcceptEnabled": "Y",
                    "acceptType": "form",
                    "received": "N",
                    "formInfo": {
                        "field": "姓名",
                        "tips": "请输入您的名称",
                        "type": "userName",
                        "required": true
                    },
                    "prizeUrl": null,
                    "qrCode": null,
                    "qrCodeTips": null
                },
                "taskStatus": 1,
                "rewardStatus": 1,
                "finishTime": 1742284276000,
                "outTradeErrCode": null,
                "outTradeErrDesc": null,
                "participated": true
            }
        ]
    },
    "success": true
}

异常示例

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