批量新增觀看白名單

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

介面URL

https://api.polyv.net/live/v3/channel/auth/batch-add-white-list

介面說明

1、作用：用於批量新增觀看白名單
2、介面支援https協定

支援格式

JSON

請求方式

POST

請求數限制

TRUE

請求參數

參數名	必選	類型	說明
appId	是	string	從API設定中取得，在直播系統登記的appId
timestamp	是	string	目前時間的秒級時間戳（13位）
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	否	int	頻道號（傳頻道號則新增頻道觀看白名單，不傳頻道號則新增全域觀看白名單）
rank	是	int	主要觀看條件為1,次要觀看條件為2
whiteLists	是	array	請求體參數, 白名單列表
whiteLists.code	是	string	請求體的參數, 白名單會員碼
whiteLists.name	是	string	請求體的參數, 白名單暱稱

操作成功回應範例

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

操作失敗回應範例

簽名錯誤

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

白名單列表格式錯誤

{
    "code": 400,
    "status": "error"
    "message": "whitelist validate error",
    "data": ""
}

回應欄位說明

名稱	類型	說明
code	string	回應代碼，成功為200，失敗為400，簽名錯誤為401，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data	string	成功回傳資訊

java請求範例

private void testBatchAddWhiteList() {
        String url = "https://api.polyv.net/live/v3/channel/auth/batch-add-white-list";
        // appId和加密串
        String appId = "xxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxx";
        String channelId = "10001";
        String rank = "1";

        Map<String, String> params = new HashMap<>();
        params.put("channelId", channelId);
        params.put("rank", rank);
        
        String body = "{\"whiteLists\": [{\"code\":\"1111\", \"name\":\"2222\"},{\"code\":\"1111eee\", \"name\":\"2222eee\"}]}";
        
        // 调用Polyv的工具类方法设置sign
        PolyvTool.setLiveSign(params, appId, appSecret);
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params, body);
        System.out.println(content);
    }