保利威文档中心

幫助中心

下載頻道中獎記錄

更新時間:2022-09-27 11:32:05

介面說明

1、导出频道的单抽奖的中奖用户列表的中奖文件
2、导出表格格式可具体参考直播后台的导出中奖记录功能
3、接口支持https协议

介面URL

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

請求方式

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,該參數取得自【查詢頻道抽獎記錄

範例

http://api.polyv.net/live/v3/channel/lottery/download-winner-detail?appId=frlr1zazn3&sign=2C9656549D3579CE1F06EF722BD390D1&channelId=1965681&timestamp=1621844995312&lotteryId=fv3hogjmh3

回應參數說明

回應成功時,介面回傳檔案串流,格式為.xls,可自行儲存檔案。

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 testDownloadWinnerDetail() 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/download-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));
    byte[] binary = HttpUtil.getBinary(url, requestMap, null);
    String path = getClass().getResource("/file/").getPath() + "DownloadWinnerDetail.xls";
    HttpUtil.writeFile(binary, path);
    log.info("测试下载频道场次中奖记录接口返回值:{}",path);
    //do somethings
}

回應範例

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

成功範例

/C:/IDEA/project/polyv-api-example/target/test-classes/file/DownloadWinnerDetail.xls

異常範例

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