查詢使用者中獎記錄

更新時間：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
}