匯出頻道場次報表(圖表)
更新時間:2024-07-05 11:35:08
介面描述
1、导出频道场次报表(图表)
3、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/session/stats/export
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 直播頻道號 |
| sessionId | true | String | 直播場次號 |
範例
http://api.polyv.net/live/v3/channel/session/stats/export?appId=fso8gzbxlr×tamp=1636421147000&channelId=2659445&sessionId=sisssssdfd&sign=56933052D433EB34E9BA0F9DA5197728
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | String | 直播場次報表的下載地址(地址的有效期為60天,過期後需重新呼叫介面產生) |
Java請求範例
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 导出频道场次报表(画图表)
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testExportChannelSessionIdStats() 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/session/stats/export";
String channelId="2149710";
String sessionId= "test";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sessionId", sessionId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("导出直播场次报表,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "",
"data": "https://liveimages.videocc.net/xx/xxx/xx.xlsx"
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
{
"code": 400,
"status": "error",
"message": "Report is not ready yet, please try again later.",
"data": ""
}
