保利威文档中心

幫助中心

查詢頻道中獎記錄

更新時間:2025-09-04 09:23:43

介面描述

1、通过抽奖ID获取频道的单场抽奖的中奖用户列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/lottery/get-winner-detail

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
channelId true String 頻道號
lotteryId true String 抽獎ID,該參數取得自【查詢頻道抽獎記錄
page false Integer 查詢的頁數,預設為1
limit false Integer 查詢的每頁大小,預設為10

範例

http://api.polyv.net/live/v3/channel/lottery/get-winner-detail?appId=frlr1zazn3&sign=A53A9A7DB3B88442E3F433F8219C1029&channelId=2191532&timestamp=1621844963404&lotteryId=fwqs12puef

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 中間記錄的分頁結果,錯誤時回傳空【詳見data欄位說明

data欄位說明

參數名 類型 說明
pageSize Integer 目前資料頁數
pageNumber Integer 目前的頁數
totalItems Integer 總記錄數
contents Array 中間記錄列表 抽獎記錄列表 【詳見contents欄位說明
firstPage Boolean 是否為第一頁,值為:true/false
lastPage Boolean 是否為最後一頁,值為:true/false
nextPageNumber Integer 下一頁編號
prePageNumber Integer 上一頁編號
totalPages Integer 總頁數
startRow Integer 目前頁第一條記錄在總記錄中的位置
endRow Integer 目前頁最後一個記錄在總記錄中的位置
limit Integer 目前頁記錄個數
offset Integer 分頁資料游標

contents欄位說明

參數名 類型 說明
recordId String 中獎記錄ID
channelId String 頻道號
sessionId String 抽獎時的直播場次ID
lotteryId String 抽獎ID
viewerId String 中獎使用者ID
viewerName String 中獎使用者暱稱
winnerCode String 中獎碼
prize String 獎品名稱
name String 中獎人姓名
telephone String 手機號碼
createdTime Long 中獎時間
lastModified Long 更新時間
address String 中獎人地址
param4 String 自訂參數
param5 String 自訂參數
userId String 帳號Id
thumbnail String 獎品圖片
ext String json 格式的字串,表示中獎記錄的額外擴充資訊,對應模型類別:WinnerRecordModelExt欄位說明

WinnerRecordModelExt欄位說明

說明:中獎記錄的擴充資訊

欄位 類型及範圍 說明
receiveInfo Array 領獎人需要填寫的兌獎資訊,對應模型類別:ReceiveInfoFieldModel欄位說明

ReceiveInfoFieldModel欄位說明

說明:中獎記錄填寫的領獎資訊

欄位 類型 說明
field String 填寫的欄位名稱
value String 填寫的欄位值

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);

/**
 * 依查询频道场次中奖记录
 * @throws IOException
 */
@Test
public void testGetWinnerDetail() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/lottery/get-winner-detail";
    String channelId = "1965681";
    String lotteryId = "fv3hogjmh3";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("lotteryId",lotteryId);

    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url,requestMap);
    log.info("测试查询频道场次中奖记录接口返回值:{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 1,
        "contents": [{
            "recordId": "b20c0e091d",
            "channelId": 1965681,
            "lotteryId": "fv3hogjmh3",
            "sessionId": "fv3hmq3qml",
            "viewerId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
            "viewerName": "王勋",
            "winnerCode": "wMpUjVSi",
            "prize": "10元现金红包",
            "name": null,
            "telephone": null,
            "createdTime": 1611127338000,
            "lastModified": 1611127338000,
            "address": null,
            "param4": "oi_ubsz8bujEA8TXdMzPpAxbC0ZI",
            "param5": null,
            "userId": "1b448be323",
            "ext": null
        }],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "prePageNumber": 1,
        "limit": 1,
        "totalPages": 1,
        "nextPageNumber": 1,
        "endRow": 1,
        "offset": 0
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询