批次新增白名單

更新時間：2023-11-23 18:30:45

介面描述

1、批量新增白名单
2、白名单数量上限是1万条
3、单次只允许增加同一频道的记录
4、校验会员码是否重复时，不区分大小写
5、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
6、接口支持https协议

介面URL

https://api.polyv.net/meet/v1/channel/auth-whitelist/save-batch

請求方式

POST

介面限制

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

請求參數描述

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

請求體參數描述

參數名	必選	類型	說明
list	true	Array	批次插入記錄【詳見list欄位說明】

list欄位說明

參數名	必選	類型	說明
code	true	String	會員碼，長度不超過64位（不可重複）
name	true	String	與會人暱稱，長度不超過64位
groupNo	false	Integer	分組序號，1~50之間（需與組內身份同時傳或同時不傳）
groupRole	false	String	組內身份，一個分組內不能多於一個組長（需與分組序號同時傳或同時不傳） leader：組長 member：組員

範例

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

請求體參數

{
  "list" : [{
    "code": "code1",
    "name": "name1",
    "groupNo": 1,
    "groupRole": "leader"
  }, {
    "code": "code2",
    "name": "name2"
  }, {

    "code": "code3",
    "name": "name3",
    "groupNo": 2,
    "groupRole": "member"
  }]
}

回應參數描述

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

Error參數描述

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

data欄位說明

參數名	必選	類型
infoIncorrectCodeList	Array	資訊不合法的會員碼。（暱稱為空/暱稱長度大於64位/分組序號不在1~50之間/組內身份傳參有誤）
duplicateCodeList	Array	會員碼重複的清單
duplicateLeaderGroupNoList	Array	重複組長的分組序號

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WhitelistSaveBatch.class);
/**
 * 批量新增白名单
 * @throws IOException
 */
@Test
public void testWhitelistSaveBatch() 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/save-batch";
    String channelId = "2191532";
    String body = "{\n" +
        "  \"list\" : [{\n" +
        "    \"code\": \"code1\",\n" +
        "    \"name\": \"name1\",\n" +
        "    \"groupNo\": 1,\n" +
        "    \"groupRole\": \"leader\"\n" +
        "  }, {\n" +
        "\n" +
        "    \"code\": \"code2\",\n" +
        "    \"name\": \"name2\"\n" +
        "  }, {\n" +
        "\n" +
        "    \"code\": \"code3\",\n" +
        "    \"name\": \"name3\",\n" +
        "    \"groupNo\": 2,\n" +
        "    \"groupRole\": \"member\"\n" +
        "  }]\n" +
        "}";

    //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));
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    log.info("测试批量新增白名单接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "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": "991b5a56d10b475d8ac973e8a2b11a5f.62.16655589121330147",
  "error": {
    "code": 50206,
    "desc": "批量插入白名单失败，信息有误"
  },
  "data": {
    "infoIncorrectCodeList": [
      "code3"
    ],
    "duplicateCodeList": [
      "code3",
      "code2",
      "code1"
    ],
    "duplicateLeaderGroupNoList": [
      1
    ],
    "correct": false
  },
  "success": false
}

{
  "code": 400,
  "status": "error",
  "requestId": "f02d8d1c81b94bf3b761efb9b9bc1fd2.58.16577892258410007",
  "error": {
    "code": 50205,
    "desc": "白名单数量超过限制，最多10000条数据"
  },
  "data": {
    "infoIncorrectCodeList": [],
    "duplicateCodeList": [],
    "duplicateLeaderGroupNoList": [],
    "correct": false
  },
  "success": false
}