刪除頻道白名單

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

介面描述

1、用于删除指定观看白名单（支持一键清空）
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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
isClear	true	String	是否一鍵清空白名單 Y：清空白名單 N：根據請求參數code清除白名單
channelId	false	String	頻道號（傳頻道號則刪除頻道觀看白名單，不傳頻道號則刪除全域觀看白名單-僅舊版後台通用設定生效）
code	false	String	會員碼（請求參數isClear 為N時為必傳參數）

範例

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

表單參數：

code=%E4%BC%9A%E5%91%98%E7%A0%81123&appId=frlr1zazn3&sign=CBBD8743AED83A64581298E4A112B823&rank=1&isClear=N&channelId=1965681&timestamp=1621844063086

回應參數描述

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

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 testDeleteWhiteList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/auth/delete-white-list";
    String channelId = "1965681";
    String rank = "1";
    String isClear = "N";
    String code = "会员码123";
    
    //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("isClear",isClear);
    requestMap.put("code",code);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试删除频道白名单：{}",response);
    //do somethings

}

回應範例

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

成功範例

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

異常範例

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