查询频道连麦使用量
更新时间: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": ""
}
