查询频道白名单

接口描述

1、获取全局或频道的观看条件白名单列表
2、接口支持https协议

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

示例

https://api.polyv.net/live/v3/channel/auth/get-white-list?appId=frlr1zazn3&sign=5935F7E2423B2AF9E0E8FE59D54D5ACC&rank=1&channelId=1965681&timestamp=1621843843501

响应参数描述

data字段说明

contents字段说明

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 testGetWhiteList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String url = "https://api.polyv.net/live/v3/channel/auth/get-white-list";
    String rank = "1";
    //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("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道白名单接口返回值：{}",response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "totalPages": 1,
        "pageSize": 10,
        "contents": [{
            "phone": "123rock",
            "name": "rock"
        }, {
            "phone": "会员码123",
            "name": "昵称123"
        }, {
            "phone": "a1",
            "name": "sadboy1"
        }, {
            "phone": "a2",
            "name": "sadboy2"
        }, {
            "phone": "a3",
            "name": "sadboy3"
        }, {
            "phone": "a4",
            "name": "sadboy4"
        }, {
            "phone": "a5",
            "name": "sadboy5"
        }, {
            "phone": "a6",
            "name": "sadboy6"
        }, {
            "phone": "a7",
            "name": "sadboy7"
        }]
    }
}

异常示例

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