Add Single Whitelist to Channel

Updated: 2024-04-22 19:18:32

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used for generating the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data.` See signature generation rules
rank	true	Integer	Primary viewing condition is 1, secondary viewing condition is 2
code	true	String	Membership code (maximum 50 characters)
name	false	String	Nickname (maximum 50 characters)
channelId	false	String	Channel ID (if provided, adds whitelist for the channel; if not provided, adds global viewing whitelist - only effective for legacy backend general settings)

Example

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

Form Parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 indicates success, non-200 indicates failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	String	Returns "success" on success, empty on failure

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download source code. After downloading, add it to your own project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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