Download Channel Viewing Records

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

API Description

1、下载频道的登记观看列表，包含登记观看记录字段和数据内容
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/auth/download-record-info

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate 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 within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret 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]
channelId	true	String	Channel ID
rank	true	Integer	1 for primary condition, 2 for secondary condition. Affects the exported table header.

Example

https://api.polyv.net/live/v3/channel/auth/download-record-info?appId=frlr1zazn3&sign=B828D9F48AED6339B39CAD50A8E47C6B&rank=2&channelId=1965681&timestamp=1621844722330

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 the base code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained 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 testDownloadRecordInfo() 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-record-info";
    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() + "DownloadRecordInfo.xls";
    HttpUtil.writeFile(binary, path);
    log.info("测试下载频道登记观看记录接口返回值：{}",path);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Descriptions

Success Example

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

Error Example

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

Live Streaming Server API