保利威文档中心

帮助中心

查询用户中奖记录

更新时间:2024-11-11 18:23:38

接口描述

1、查询用户中奖记录
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/lottery/list-personal-win

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥
timestamp true Long 当前13位毫秒级时间戳,3分钟内有效
sign true String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
viewerId true String 观众id
pageSize true String 分页大小
pageNumber true String 页码

示例

http://api.polyv.net/live/v4/user/lottery/list-personal-win?appId=frlr1zazn3&sign=7F2F91A6A01C9BBA844141088C5E9F71&timestamp=1672884419075&viewerId=123&pageNumber=1&pageSize=10

响应参数描述

参数名 类型 说明
code Integer 状态码,与 http 状态码相同,用于确定基本的响应状态
status String 响应结果,由业务决定,成功返回success,失败返回error
success Boolean 是否成功响应
requestId String 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
error Object 状态码非200时的错误信息【详见Error字段描述
data Object 【详见data字段说明

Error参数描述

参数名 类型 说明
code Integer 错误代码,用于确定具体的错误原因
desc String 错误描述,与 error.code 对应

data参数描述

参数名 类型 说明
pageNumber String 页码
pageSize String 页面大小
totalPages String 总页数
totalItems String 总记录数
contents Array 抽奖信息数组 【详见contents字段说明

contents参数描述

参数名 类型 说明
channelId Integer 频道id
channelName String 频道名称
sessionId String 场次id
collectInfo String 收货信息JSON字符串
acceptType String 领取方式(form:表单,link:链接,qrCode:二维码)
lotteryId String 抽奖id
prize String 奖品名称
received boolean 是否已领取(true/false)
winnerCode String 兑奖码
activityName String 活动名
createdTime Long 中奖时间
lastModified Long 最后更新时间
receiveEnabled boolean 是否收集信息(Y/N)

Java请求示例

快速接入基础代码请下载相关依赖源码点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

/**
 * 查询中奖记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getGlobalFooterSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/lottery/list-personal-win";
    
    //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": "59c9c97d15174c9687f6abeda8c6ebe3.66.17262970693838787",
    "data": {
        "pageNumber": 1,
        "pageSize": 20,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "channelId": "3637403",
                "channelName": "视频内容风险识别",
                "sessionId": "ggsgdqza9s",
                "collectInfo": "[{\"tips\":\"请输入您的名称\",\"required\":true,\"field\":\"姓名\",\"value\":\"观众\"},{\"tips\":\"请输入您的手机号码\",\"required\":true,\"field\":\"手机\",\"value\":\"131xxxx6615\"}]",
                "acceptType": null,
                "lotteryId": "ggsgf33ext",
                "prize": "2",
                "thumbnail": null,
                "received": true,
                "winnerCode": "w3hiMHut",
                "activityName": "答题抽奖导出",
                "createdTime": 1672327042000,
                "lastModified": 1672327083000,
                "receiveEnabled": null
            }
        ]
    },
    "success": true
}

异常示例

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