分頁查詢白名單

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

介面說明

1、分页查询白名单
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递
3、接口支持https协议

介面URL

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

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值【詳見簽名產生規則】
channelId	true	Integer	頻道號碼
pageNumber	false	Integer	目前頁碼，1~1000之間取值；不傳預設1
pageSize	false	Integer	單頁數量，1~1000之間取值；不傳預設10

範例

https://api.polyv.net/meet/v1/channel/auth-whitelist/get?appId=fyirmfdak4&timestamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=2191532&pageNumber=3&pageSize=10

回應參數說明

參數名	類型	說明
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欄位說明

參數名	類型	說明
pageSize	Integer	每頁資料大小，預設10，最大值1000
pageNumber	Integer	目前的頁數
totalItems	Integer	總筆數
contents	Array	查詢的結果列表【詳見Contents參數說明】
totalPages	Integer	總頁數

Contents參數說明

參數名	類型	說明
channelId	Integer	頻道號碼
userId	String	帳號id
code	String	會員碼
name	String	與會暱稱
groupNo	Integer	分組序號
groupName	String	分組名稱
groupRole	String	組內身份 leader：組長 member：組員

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WhitelistGet.class);
/**
 * 分页查询白名单
 * @throws IOException
 */
@Test
public void testWhitelistGet() 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/get";
    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.get(url, requestMap);
    log.info("测试分页查询白名单接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "9d87a0743cd741e2ad7100ee83459f64.62.16655593873260005",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 5,
    "contents": [
      {
        "channelId": 2191532,
        "userId": "1b448be323",
        "code": "code1",
        "name": "name1",
        "groupNo": 1,
        "groupName": "1组",
        "groupRole": "leader"
      },
      {
        "channelId": 2191532,
        "userId": "1b448be323",
        "code": "code2",
        "name": "name2",
        "groupNo": 1,
        "groupName": "1组",
        "groupRole": "member"
      },
      {
        "channelId": 2191532,
        "userId": "1b448be323",
        "code": "11",
        "name": "11",
        "groupNo": 1,
        "groupName": "1组",
        "groupRole": "member"
      },
      {
        "channelId": 2191532,
        "userId": "1b448be323",
        "code": "111",
        "name": "name111",
        "groupNo": 1,
        "groupName": "1组",
        "groupRole": "member"
      },
      {
        "channelId": 2191532,
        "userId": "1b448be323",
        "code": "code3",
        "name": "name3",
        "groupNo": 2,
        "groupName": "2组",
        "groupRole": "member"
      }
    ]
  },
  "success": 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": "9d87a0743cd741e2ad7100ee83459f64.59.16655595201740017",
  "error": {
    "code": 10001,
    "desc": "单次查询不能大于1000条"
  },
  "data": null,
  "success": false
}