查詢觀眾中獎記錄

更新時間：2022-10-13 10:52:53

介面描述

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

介面URL

http://api.polyv.net/live/v4/channel/lottery/query-winner-viewer

請求方式

GET

介面限制

1、介面同時支援 HTTP 及 HTTPS，建議使用 HTTPS 以確保介面安全，介面呼叫有頻率限制，詳細請查看

2、若觀眾中獎記錄不存在則會回應 400 異常

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號 appId【詳見取得金鑰】
timestamp	true	Long	當前 13 位毫秒級時間戳，3 分鐘內有效
sign	true	String	簽名，為 32 位大寫的 MD5 值，`產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有 API 都必須透過客戶自己伺服器中轉呼叫 POLYV 伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
lotteryId	true	String	抽獎 ID
viewerId	true	String	觀眾 ID

範例

http://api.polyv.net/live//v4/channel/lottery/query-winner-viewer?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342&lotteryId=g9pf1atsa3&viewerId=ovtl9twa7JHyHBBA8QUNVjjM4WIs

回應參數描述

參數名	類型	說明
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 參數描述

參數名	類型	說明
recordId	String	中獎記錄 ID
channelId	Integer	頻道號
lotteryId	String	抽獎 ID
sessionId	String	抽獎時的直播場次 ID
viewerId	String	觀眾 ID
viewerName	String	觀眾暱稱
winnerCode	String	中獎碼
prize	String	獎品名稱
name	String	中獎人姓名
telephone	String	中獎人聯絡方式
createdTime	Long	建立時間，可表示中獎時間，13 位毫秒級時間戳
lastModified	Long	更新時間，13 位毫秒級時間戳
address	String	中獎人地址
ext	Object	中獎記錄的額外擴充資訊【詳見ext 欄位說明】
param4	String	使用者自訂參數，在直接授權觀看條件或獨立授權時可能帶過來的參數
param5	String	使用者自訂參數，在直接授權觀看條件或獨立授權時可能帶過來的參數
userId	String	帳號 ID
avatar	String	頭像
totalUsers	Integer	參與抽獎的總人數

ext 參數描述

參數名	類型	說明
receiveInfo	Array	中獎記錄的額外擴充資訊【詳見receiveInfo 欄位說明】

receiveInfo 參數描述

參數名	類型	說明
field	String	欄位名稱
value	String	欄位值

Java 請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播 Java SDK 完成 API 的功能對接，直播 Java SDK 對 API 呼叫邏輯、異常處理、資料簽名、HTTP 請求執行緒池進行了統一封裝和最佳化。

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "fc0894ce-08df-4376-92e2-fd0531cbe8ba",
    "data": {
        "recordId": "22ad8e0518",
        "channelId": 2974342,
        "lotteryId": "g9pf1atsa3",
        "sessionId": "g9pf13d8bo",
        "viewerId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
        "viewerName": "神经蛙",
        "winnerCode": "OOf6jo74",
        "prize": "百万   大礼包",
        "name": null,
        "telephone": null,
        "createdTime": 1652341190000,
        "lastModified": 1652341226000,
        "address": null,
        "ext": {
            "receiveInfo": [
                {
                    "field": "姓名：",
                    "value": "我"
                },
                {
                    "field": "手机：",
                    "value": "18888888888"
                }
            ]
        },
        "param4": "oi_ubsz8bujEA8TXdMzPpAxbC0ZI",
        "param5": null,
        "userId": "1b448be323",
        "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM48yCrkV6bNEauNqC60hZJ38eZkVt5YBiasWbq4MA9I5kgs6Oodicc5vpXSICosTibybCT5mgibhIwCNA/132",
        "totalUsers": 2
    },
    "success": true
}

異常範例

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

中獎記錄不存在

{
    "code": 400,
    "status": "error",
    "requestId": "d29944cb-66ac-4694-a844-5ec619e17abd",
    "error": {
        "code": 40031,
        "desc": "中奖记录不存在"
    },
    "data": null,
    "success": false
}