Query User Winning Records

Updated: 2024-11-11 18:23:38

API Description

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

API URL

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

Online API Call

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
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 saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
viewerId	true	String	Viewer ID
pageSize	true	String	Page size
pageNumber	true	String	Page number

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when status code is not 200 See Error field description
data	Object	See data field description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error
desc	String	Error description, corresponding to error.code

Data Parameter Description

Parameter	Type	Description
pageNumber	String	Page number
pageSize	String	Page size
totalPages	String	Total number of pages
totalItems	String	Total number of records
contents	Array	Lottery information array See contents field description

Contents Parameter Description

Parameter	Type	Description
channelId	Integer	Channel ID
channelName	String	Channel name
sessionId	String	Session ID
collectInfo	String	Shipping information JSON string
acceptType	String	Collection method (form: form, link: link, qrCode: QR code)
lotteryId	String	Lottery ID
prize	String	Prize name
received	boolean	Whether claimed (true/false)
winnerCode	String	Redemption code
activityName	String	Activity name
createdTime	Long	Winning time
lastModified	Long	Last update time
receiveEnabled	boolean	Whether to collect information (Y/N)

Java Request Example

For quick integration of basic 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 test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

/**
 * 查询中奖记录
 * @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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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

Live Streaming Server API