Delete Channel Whitelist

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

API Description

1、用于删除指定观看白名单（支持一键清空）
2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API 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 within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored 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 for response data.` See signature generation rules
rank	true	Integer	Primary viewing condition is 1, secondary viewing condition is 2
isClear	true	String	Whether to clear the whitelist in one click Y: Clear whitelist N: Clear whitelist based on the request parameter code
channelId	false	String	Channel ID (pass channel ID to delete channel viewing whitelist; do not pass channel ID to delete global viewing whitelist - only effective for legacy backend general settings)
code	false	String	Membership code (required when the request parameter isClear is N)

Example

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

Form Parameters:

code=%E4%BC%9A%E5%91%98%E7%A0%81123&appId=frlr1zazn3&sign=CBBD8743AED83A64581298E4A112B823&rank=1&isClear=N&channelId=1965681&timestamp=1621844063086

Response Parameter Description

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

Java Request Example

For quick integration of basic code, please download the related dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included 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 testDeleteWhiteList() 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/delete-white-list";
    String channelId = "1965681";
    String rank = "1";
    String isClear = "N";
    String code = "会员码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("isClear",isClear);
    requestMap.put("code",code);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试删除频道白名单：{}",response);
    //do somethings

}

Response Example

For system global 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": ""
}