下载频道白名单

接口描述

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

接口URL

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

请求方式

GET

接口约束

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

请求参数描述

参数名
必选
类型
说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

rank

true

Integer

1为首要条件，2为次要条件。

channelId

false

String

频道号，不传为全局下载

示例

https://api.polyv.net/live/v3/channel/auth/download-white-list?appId=frlr1zazn3&sign=31BC3BB8427E1471F60F74B9BA932A40&rank=1&channelId=1965681&timestamp=1621844101001

响应参数描述

响应成功时，接口返回文件流，格式为.xls，可以自行保存文件。

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 testDownloadWhiteList() 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 = "http://api.polyv.net/live/v3/channel/auth/download-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));
    byte[] binary = HttpUtil.getBinary(url, requestMap, null);
    String path = getClass().getResource("/file/").getPath() + "DownloadWhiteList.xls";
    HttpUtil.writeFile(binary, path);
    log.info("测试下载频道白名单接口返回值：{}",path);
    //do somethings

}

响应示例

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

成功示例

/C:/IDEA/project/polyv-api-example/target/test-classes/file/DownloadWhiteList.xls

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
Previous下载频道登记观看记录Next查询报名观看记录

Last updated

Was this helpful?