批量导入频道白名单

更新时间：2024-04-22 19:18:32

接口描述

1、设置频道或全局观看条件中的白名单列表
2、（channelId, rank, timestamp, appId）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
3、接口支持https协议

接口URL

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

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看
2、如导入数据与现有列表数据会员码一致，则会以导入昵称覆盖现有昵称

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	false	String	频道号，不传为全局设置-仅旧版后台通用设置生效
rank	true	Integer	1为首要条件，2为次要条件。影响导出的表格表头
file	true	File	白名单文件（点击下载白名单模板）

示例

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

表单参数：

channed=1965681&appId=frlr1zazn3&sign=BC6B72C26EC0919FDA7F3F79DAFA9C00&rank=1&timestamp=1621843911295

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	成功时为true，错误时为空

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 testUploadWhiteList() 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/upload-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);
    File file = new File(getClass().getResource("/file/").getPath() + "WhiteListTemplate.xls");
    Map<String, File> fileMap = new HashMap<>();
    fileMap.put("file", file);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url, requestMap, fileMap, null);
    log.info("测试批量导入频道白名单接口返回值：{}",response);
    //do somethings

}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

异常示例

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

直播服务端 API