查询隔离区账单列表
更新时间:2022-09-02 18:08:07
接口描述
1、集团账号查询主账号账单
2、接口支持https协议
接口URL
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、集团账号接口计算签名请使用集团主账号的appId、appSecret
3、账期传入时间需要在202204以后
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 集团主账号appId |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| billingDate | true | String | 账期,格式yyyyMM,比如202205,时间需要在202204以后 |
| isolationId | true | String | 隔离区ID,使用创建账号返回的【用户全局ID】,即userId 隔离区ID不能跨集团账号使用 |
| pageSize | false | Integer | 每页数据大小,默认10,最大值1000 |
| pageNumber | false | Integer | 当前的页数,默认1 |
示例
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见Error字段描述】 |
| data | Object | 账单列表【详见data字段说明】 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | Integer | 当前页码 |
| pageSize | Integer | 每页数据量 |
| totalPages | Long | 页面总数 |
| totalItems | Long | 总数据量 |
| contents | Array | 当前页内容【详见contents字段说明】 |
Contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| unionId | String | 集团主帐号ID |
| accountPeriod | String | 账期 |
| production | String | 产品 云直播/云点播 |
| category | String | 用量类型 云直播:观看分钟数/连麦分钟数/无延迟分钟数/导播时长 云点播:视频播放/存储空间 |
| itemConsumed | Float | 用量 |
| itemConsumedUnit | String | 用量单位 |
| statAt | String | 结算日期,天,格式为YYYY-MM-DD |
| tradeType | Integer | 交易类型 1:用量结算 2:金额结算 3:补扣调账 4:退费调账 |
Java请求示例
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "71c487ed89a94ca0b29e8779ea96f84b.57.16529454016270601",
"data":
{
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 7,
"contents": [
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "直播",
"category": "导播时长",
"itemConsumed": 120.00,
"itemConsumedUnit": "分钟",
"statAt": "2022-05-12",
"tradeType": 1
},
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "直播",
"category": "导播时长",
"itemConsumed": 80.00,
"itemConsumedUnit": "分钟",
"statAt": "2022-05-12",
"tradeType": 2
},
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "直播",
"category": "国内观看时长",
"itemConsumed": 71.00,
"itemConsumedUnit": "分钟",
"statAt": "2022-05-16",
"tradeType": 2
},
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "点播",
"category": "存储空间",
"itemConsumed": 0.50,
"itemConsumedUnit": "GB",
"statAt": "2022-05-17",
"tradeType": 2
},
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "直播",
"category": "国内观看时长",
"itemConsumed": 88.00,
"itemConsumedUnit": "分钟",
"statAt": "2022-05-18",
"tradeType": 2
},
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "点播",
"category": "存储空间",
"itemConsumed": 0.50,
"itemConsumedUnit": "GB",
"statAt": "2022-05-18",
"tradeType": 2
},
{
"unionId": "******",
"accountPeriod": "2022-05",
"email": null,
"memo": null,
"production": "点播",
"category": "存储空间",
"itemConsumed": 0.50,
"itemConsumedUnit": "GB",
"statAt": "2022-05-19",
"tradeType": 2
}]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
