查询用户账单使用明细数据
更新时间:2026-08-03 16:22:07
接口描述
1、查询用户账单使用明细数据
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/use-detail/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | String | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| itemCategory | true | String | 计费项,必填;duration:直播分钟数;concurrence:直播并发;mic_duration:连麦分钟数;ppt_anim:PPT动效转码;guide_duration:导播台;ppt_composite :重制课件;distribute:云分发;aiPPTVideoEnabled:智能制课(不含数字人);aiPPTVideoWithDigital:智能制课(含数字人);aiAssistantEnabled:AI 助手答疑;aiSmartClipEnabled:智能裁剪 |
| startDate | true | String | 开始日期,必填,格式:yyyy-MM-dd,不允许跨月查询 |
| endDate | true | String | 结束日期,必填,格式:yyyy-MM-dd,不允许跨月查询 |
| channelId | false | String | 频道号,非必填 |
| pageNumber | false | String | 当前页数,第几页 |
| pageSize | false | String | 分页大小 |
示例
http://api.polyv.net/live/v4/channel/use-detail/list?pageNumber=1&endDate=2023-08-04&itemCategory=duration&appId=frlr1zazn3&sign=EAD6F8790A2AD758C4D15FD81216E074&pageSize=10&startDate=2023-08-04×tamp=1691131787072
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| data | Object | 【详见Data参数描述】 |
| error | Object | 状态码非200时的错误信息【详见Error参数描述】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| contents | Array | 分页数据集合【详见Contents参数描述】 |
| pageNumber | Integer | 当前页数,第几页 |
| pageSize | Integer | 分页大小 |
| totalItems | Integer | 总记录数 |
| totalPages | Integer | 总页数 |
Contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | Integer | 频道号 |
| consumeUnit | String | 用量单位 |
| consumed | Integer | 使用用量 |
| endTime | String | 结束时间 |
| itemCategory | String | 计费项,duration:直播分钟数;concurrence:直播并发;mic_duration:连麦分钟数; ppt_anim:PPT动效转码;guide_duration:导播台;ppt_composite:重制课件;distribute:云分发 |
| itemName | String | 项目明细,如:国内观看时长、1v1~6 连麦等 |
| production | String | 产品,如:live |
| recordId | String | 记录id |
| remark | String | 备注 |
| sessionId | String | 场次号,无场次数据时为空 |
| avgBitRate | String | 平均码率,单位:kbps,无码率数据时为空 |
| startTime | String | 开始时间 |
| statDate | String | 出账日期 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询用户账单使用明细数据
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void useDetailListTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/channel/use-detail/list";
String startDate = "2023-08-04";
String endDate = "2023-08-04";
String itemCategory = "duration";
String pageNumber = "1";
String pageSize = "10";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("endDate", endDate);
requestMap.put("itemCategory", itemCategory);
requestMap.put("startDate", startDate);
requestMap.put("timestamp", timestamp);
requestMap.put("pageNumber", pageNumber);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询用户账单使用明细数据成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "f2d3faf76c90440b80b91a21a36df545.67.16911317891895057",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"statDate": "2023-08-04",
"production": "直播",
"itemCategory": "直播分钟数",
"itemName": "国内观看时长",
"channelId": 3346714,
"recordId": "test-001234",
"consumed": 1,
"consumeUnit": "分钟",
"startTime": "2023-08-04 13:03:01",
"endTime": "2023-08-04 14:48:36",
"remark": "测试-001234",
"sessionId": "20230804130301999999",
"avgBitRate": "1200"
}
]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
