批次匯入頻道白名單

更新時間：2024-04-22 19:18:32

介面說明

1、设置频道或全局观看条件中的白名单列表
2、（channelId, rank, timestamp, appId）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
3、接口支持https协议

介面URL

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

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看
2、若匯入資料與現有列表資料會員碼一致，則會以匯入暱稱覆蓋現有暱稱

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	false	String	頻道號，不傳為全域設定-僅舊版後台通用設定生效
rank	true	Integer	1為首要條件，2為次要條件。影響匯出的表格表頭
file	true	File	白名單檔案（點擊下載白名單模板）

範例

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

表單參數：

channed=1965681&appId=frlr1zazn3&sign=BC6B72C26EC0919FDA7F3F79DAFA9C00&rank=1&timestamp=1621843911295

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	String	成功時為true，錯誤時為空

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 testUploadWhiteList() 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/upload-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);
    File file = new File(getClass().getResource("/file/").getPath() + "WhiteListTemplate.xls");
    Map<String, File> fileMap = new HashMap<>();
    fileMap.put("file", file);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url, requestMap, fileMap, null);
    log.info("测试批量导入频道白名单接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

異常範例

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