清空白名單

更新時間：2022-10-12 15:25:43

介面描述

1、清空白名单
2、接口支持https协议

介面URL

https://api.polyv.net/meet/v1/channel/auth-whitelist/delete-all

請求方式

POST

介面限制

1、介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值【詳見簽名生成規則】
channelId	true	Integer	頻道號

範例

https://api.polyv.net/meet/v1/channel/auth-whitelist/delete-all?appId=fyirmfdak4&timestamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=3220878

響應參數描述

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的響應狀態
status	String	響應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	是否成功響應
requestId	String	請求ID，每次請求生成的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位描述】
data	String	成功時為true，錯誤時為空

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WhitelistDeleteAll.class);
/**
 * 清空白名单
 * @throws IOException
 */
@Test
public void testWhitelistDeleteAll() 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/meet/v1/channel/auth-whitelist/delete-all";
    String channelId = "2191532";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("清空白名单，返回值：{}",response);

}

響應範例

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

成功範例

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

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}

{
  "code": 403,
  "status": "error",
  "error": {
    "code": 10002,
    "desc": "签名错误"
  },
  "success": false
}

{
  "code": 400,
  "status": "error",
  "requestId": "20e774c2414447fe9d44801ff92a7d39.69.16655431425530263",
  "error": {
    "code": 30005,
    "desc": "非法频道ID: 3344784"
  },
  "success": false
}