分页查询白名单

接口描述

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

接口URL

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

请求方式

GET

接口约束

1、接口调用有频率限制，详细请查看

请求参数描述

示例

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

响应参数描述

Error参数描述

data字段说明

Contents参数描述

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
}