userBillService
更新时间:2025-09-11 15:18:09
1、查询用户账单使用详情数据
描述
查询用户账单使用详情数据
接口地址(仅做说明使用):https://api.polyv.net/live//v4/channel/use-detail/list
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
@Test
public void testGetBillUseDetailData() throws IOException, NoSuchAlgorithmException {
LiveGetBillUseDetailRequest liveGetBillUseDetailRequest = new LiveGetBillUseDetailRequest();
LiveGetBillUseDetailResponse liveGetBillUseDetailResponse;
try {
liveGetBillUseDetailRequest.setItemCategory("duration")
.setStartDate(super.getDate(2025, 2, 1))
.setEndDate(super.getDate(2025, 2, 31));
liveGetBillUseDetailResponse = new LiveUserBillServiceImpl().getBillUseDetail(liveGetBillUseDetailRequest);
Assert.assertNotNull(liveGetBillUseDetailResponse);
if (liveGetBillUseDetailResponse != null) {
log.debug("测试查询用户账单使用详情数据成功 {}", JSON.toJSONString(liveGetBillUseDetailResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
}
单元测试说明
1、请求正确,返回LiveGetBillUseDetailResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| itemCategory | true | String | 计费项,必填; duration:直播分钟数; concurrence:直播并发; mic_duration:连麦分钟数; ppt_anim:PPT动效转码; guide_duration:导播台; ppt_composite:重制课件; distribute:云分发; aiPPTVideoEnabled:智能制课(不含数字人); aiPPTVideoWithDigital:智能制课(含数字人); aiAssistantEnabled:AI助手答疑; aiSmartClipEnabled:智能裁剪 |
| startDate | true | Date | 开始日期,必填,格式:yyyy-MM-dd,不允许跨月查询 |
| endDate | true | Date | 结束日期,必填,格式:yyyy-MM-dd,不允许跨月查询 |
| channelId | false | String | 频道号 |
| currentPage | false | Integer | 页数,默认为1【对应api文档的pageNumber字段】 |
| pageSize | false | Integer | 每页显示的数据条数,默认每页显示20条数据 |
| appId | false | String | POLYV用户APP_ID,多账号调用时该参数必填(即调用了initMultiAccount()设置多账号调用),通过注册保利威官网获取,路径:官网->登录->直播(开发设置) |
| appSecret | false | String | POLYV用户APP_SECRET,多账号调用时该参数必填(即调用了initMultiAccount()设置多账号调用),通过注册保利威官网获取,路径:官网->登录->直播(开发设置) |
返回对象描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| contents | Array | 账单使用详情【详见BillUseDetail参数描述】 |
| pageSize | Integer | 每页显示的数据条数,默认每页显示20条数据 |
| currentPage | Integer | 当前页【对应api文档的pageNumber字段】 |
| totalItems | Integer | 记录总条数 |
| totalPage | Integer | 总页数【对应api文档的totalPages字段】 |
BillUseDetail参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | String | 频道号 |
| consumed | Integer | 用量 |
| consumeUnit | String | 用量单位 |
| endTime | Date | 结束时间 |
| 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 | 备注 |
| startTime | Date | 开始时间 |
| statDate | String | 出账日期 |
