查詢頻道連線使用量
更新時間:2022-09-02 18:08:07
介面說明
1、分页获取频道连麦使用详情,默认查询账号下的所有频道
2、支持账号、批量频道获取连麦情况使用详情
3、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/statistics/mic/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| page | false | Integer | 目前頁碼,預設1 |
| size | false | Integer | 每頁資料大小,預設10,最大值1000 |
| channelIds | false | String | 頻道號,使用英文逗號分隔,如:100000,100001,預設查詢所有頻道 |
| startDay | false | String | 開始時間,格式:yyyy-MM-dd |
| endDay | false | String | 結束時間,格式:yyyy-MM-dd |
範例
http://api.polyv.net/live/v3/channel/statistics/mic/list?size=1000&startDay=2020-1-1&appId=frlr1zazn3&endDay=2021-2-11&sign=EE4F5413AEEF3CE5557CD2B44338AD8C&page=1&channelIds=1965681%2C1958888×tamp=1621844590076
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 請求成功時為連線使用相關資訊【詳見Data參數說明】,請求失敗時為空 |
Data參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁資料大小,預設10,最大值1000 |
| pageNumber | Integer | 目前的頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 查詢的結果列表【詳見Contents參數說明】 |
| startRow | Integer | 目前頁第一筆記錄在總結果集中的位置 |
| firstPage | Boolean | 是否為第一頁,值為:true/false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false |
| prePageNumber | Integer | 上一頁編號 |
| nextPageNumber | Integer | 下一頁編號 |
| limit | Integer | 每頁數量大小 |
| totalPages | Integer | 總頁數 |
| endRow | Integer | 目前頁最後一筆記錄在總結果集中的位置 |
| offset | Integer | 分頁起始記錄 |
Contents參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| userId | String | 帳號userId |
| channelId | String | 頻道號 |
| currentDay | String | 使用日期,格式:yyyy-MM-dd |
| history | Integer | 使用連線分鐘數,單位:分鐘 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelViewDataTest.class);
/**
* 测试查询频道连麦详情数据
* @throws IOException
*/
@Test
public void testMicDetailList() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/statistics/mic/list";
String size = "1000";
String page = "1";
String startDay = "2020-1-1";
String endDay = "2021-2-11";
String channelIds = "1965681,1958888";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("size",size);
requestMap.put("page",page);
requestMap.put("startDay",startDay);
requestMap.put("endDay", endDay);
requestMap.put("channelIds", channelIds);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道连麦详情数据,返回值:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":{
"pageSize":1000,
"pageNumber":1,
"totalItems":3,
"contents":[
{
"userId":"1b448be323",
"channelId":1965681,
"currentDay":"2020-12-03",
"history":2
},
{
"userId":"1b448be323",
"channelId":1965681,
"currentDay":"2020-10-28",
"history":0
},
{
"userId":"1b448be323",
"channelId":1965681,
"currentDay":"2020-10-21",
"history":1
}
],
"startRow":1,
"firstPage":true,
"lastPage":true,
"prePageNumber":1,
"totalPages":1,
"limit":3,
"nextPageNumber":1,
"endRow":3,
"offset":0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
