Download Channel Whitelist

Updated: 2022-09-02 18:08:07

API Description

1、下载全局或频道的观看条件白名单列表
2、接口支持https协议

API URL

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

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. Click for 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 used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See: Signature Generation Rules
rank	true	Integer	1 for primary condition, 2 for secondary condition.
channelId	false	String	Channel ID. If not provided, applies to global downloads.

Example

https://api.polyv.net/live/v3/channel/auth/download-white-list?appId=frlr1zazn3&sign=31BC3BB8427E1471F60F74B9BA932A40&rank=1&channelId=1965681&timestamp=1621844101001

Response Parameter Description

On successful response, the API returns a file stream in .xls format, which can be saved locally.

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source 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 packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 下载频道白名单
 * @throws IOException
 */
@Test
public void testDownloadWhiteList() 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/download-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);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    byte[] binary = HttpUtil.getBinary(url, requestMap, null);
    String path = getClass().getResource("/file/").getPath() + "DownloadWhiteList.xls";
    HttpUtil.writeFile(binary, path);
    log.info("测试下载频道白名单接口返回值：{}",path);
    //do somethings

}

Response Example

For global error descriptions, see Global Error Description

Success Example

/C:/IDEA/project/polyv-api-example/target/test-classes/file/DownloadWhiteList.xls

Error Example

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