查询用户账单详情数据
更新时间:2026-04-24 09:32:47
接口描述
1、查询用户账单详情数据
2、接口支持https协议
接口URL
https://api.polyv.net/live/v3/finance/bill/detail
请求方式
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 | 计费项,必填;seminarDuration:研讨会参会时长;seminarRecordDuration:研讨会录制时长;duration:直播分钟数 |
| startDate | true | String | 开始日期,必填,格式:yyyy-MM-dd,不允许跨月查询 |
| endDate | true | String | 结束日期,必填,格式:yyyy-MM-dd,不允许跨月查询 |
| pageNumber | false | String | 当前页数,第几页 |
| pageSize | false | String | 分页大小 |
示例
https://api.polyv.net/live/v3/finance/bill/detail?pageNumber=1&endDate=2023-08-04&itemCategory=seminarDuration&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参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| userId | String | 账号 ID |
| accountPeriod | String | 账期 ,例如:2026-01 |
| statAt | String | 出账日期,例如:2026-01-01 |
| useDate | String | 使用日期,例如:2026-01-01 |
| itemConsumed | BigDecimal | 用量 |
| clearingItemConsumed | BigDecimal | 结算用量 |
| itemCategory | String | 计费项,seminarDuration:研讨会参会时长;seminarRecordDuration:研讨会录制时长; |
| itemName | String | 项目明细,如:1v6 会议等 |
| production | String | 产品 |
| tradeType | String | 交易类型 |
| cost | BigDecimal | 费用 |
| status | String | 账单状态,例如:已支付 |
| univalence | long | 单价 |
| univalenceUnit | String | 单价单位 |
| itemConsumedUnit | 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 = "https://api.polyv.net/live/v3/finance/bill/detail";
String startDate = "2023-08-04";
String endDate = "2023-08-04";
String itemCategory = "duration";
String pageNumber = "1";
String pageSize = "10";
String itemCategory = "seminarDuration"
//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",
"message": "",
"data": {
"pageSize": 20,
"pageNumber": 1,
"totalItems": 1,
"contents": [
{
"statAt": "2024-05-23",
"accountPeriod": "2024-05",
"production": "研讨会",
"itemCategory": "参会时长",
"tradeType": "金额结算",
"cost": 0.81,
"status": "已支付",
"itemName": "1v6 会议",
"univalence": 0.09,
"univalenceUnit": "元/分钟",
"itemConsumed": 9.0,
"clearingItemConsumed": 9.0,
"itemConsumedUnit": "分钟",
"userId": "sdsssddddddd",
"useDate": "2024-05-21"
}
],
"startRow": 1,
"firstPage": true,
"lastPage": true,
"nextPageNumber": 1,
"prePageNumber": 1,
"limit": 1,
"endRow": 1,
"totalPages": 1,
"offset": 0
}
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
