增加频道单个白名单

接口描述

1、接口用于添加单个观看白名单
2、接口支持https协议

接口URL

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

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
rank	true	Integer	主要观看条件为1，次要观看条件为2
code	true	String	会员码（最多为50个字符）
name	false	String	昵称（最多为50个字符）
channelId	false	String	频道号（传频道号则添加频道观看白名单，不传频道号则添加全局观看白名单-仅旧版后台通用设置生效）

示例

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

表单参数：

code=%E4%BC%9A%E5%91%98%E7%A0%81123&appId=frlr1zazn3&name=%E6%98%B5%E7%A7%B0123&sign=BD809AE49EC205758A2D1B86227A6E7F&rank=1&channelId=1965681&timestamp=1621843874079

响应参数描述

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

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 testAddWhiteList() 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/live/v3/channel/auth/add-white-list";
    String channelId = "1965681";
    String rank = "1";
    String code = "会员码123";
    String name = "昵称123";

    //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("code",code);
    requestMap.put("name",name);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试增加频道单个白名单：{}",response);
    //do somethings

}

响应示例

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

成功示例

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

异常示例

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