下載頻道白名單

更新時間：2022-09-02 18:08:07

介面描述

1、下载全局或频道的观看条件白名单列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/auth/download-white-list

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
rank	true	Integer	1為首要條件，2為次要條件。
channelId	false	String	頻道號，不傳為全域下載

範例

https://api.polyv.net/live/v3/channel/auth/download-white-list?appId=frlr1zazn3&sign=31BC3BB8427E1471F60F74B9BA932A40&rank=1&channelId=1965681&timestamp=1621844101001

回應參數描述

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

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 下载频道白名单
 * @throws IOException
 */
@Test
public void testDownloadWhiteList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String url = "http://api.polyv.net/live/v3/channel/auth/download-white-list";
    String rank = "1";
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("rank",rank);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    byte[] binary = HttpUtil.getBinary(url, requestMap, null);
    String path = getClass().getResource("/file/").getPath() + "DownloadWhiteList.xls";
    HttpUtil.writeFile(binary, path);
    log.info("测试下载频道白名单接口返回值：{}",path);
    //do somethings

}

回應範例

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

成功範例

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

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}