Batch Import Channel Whitelist

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

API Description

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

API URL

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

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
If the imported data has the same member code as an existing entry in the list, the imported nickname will overwrite the existing one.

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 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. All APIs must be called through your own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]
channelId	false	String	Channel ID. If not set, it applies to global settings - only effective for legacy backend general settings.
rank	true	Integer	1 for primary condition, 2 for secondary condition. Affects the exported table header.
file	true	File	Whitelist file (Click to download whitelist template)

Example

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

Form Parameters:

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

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. When code is 400 or 500, provides additional error details.
data	String	Returns true on success, empty on error.

Java Request Example

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

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 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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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