Modify a Single Whitelist Entry for a Channel

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

API Description

1、用于更新观看白名单信息
2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
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 to generate 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 for response data.` See Signature Generation Rules
rank	true	Integer	Primary viewing condition is 1, secondary viewing condition is 2
oldCode	true	String	Old membership code
code	true	String	Membership code (maximum 50 characters)
name	false	String	Nickname (maximum 50 characters)
channelId	false	String	Channel ID (pass channel ID to add channel viewing whitelist; omit to add global viewing whitelist - only effective for legacy backend general settings)

Example

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

Form Parameters:

code=%E4%BC%9A%E5%91%98%E7%A0%811&oldCode=%E4%BC%9A%E5%91%98%E7%A0%81123&appId=frlr1zazn3&name=%E6%98%B5%E7%A7%B01&sign=8EC68EE65FBCEBE8E6EC389AB586CF88&rank=1&channelId=1965681&timestamp=1621843953634

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 details when code is 400 or 500
data	String	"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 source code. Add it to your own project after downloading. 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 testUpdateWhiteList() 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/update-white-list";
    String channelId = "1965681";
    String rank = "1";
    String oldCode = "会员码123";
    String code = "会员码1";
    String name = "昵称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("oldCode",oldCode);
    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 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": ""
}

Live Streaming Server API