Polyv Help Center

Help Center

Query User Bill Details

Updated: 2026-04-24 09:32:47

API Description

1、查询用户账单详情数据

2、接口支持https协议

API URL

https://api.polyv.net/live/v3/finance/bill/detail

<a href="/req.html?api=https://api.polyv.net/live/v3/finance/bill/detail"" target="_blank">Online API Call

Request Method

GET

API Constraints

  1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Parameter Required Type Description
appId true String Account appId See Get Secret Key
timestamp true String Current 13-digit millisecond timestamp, valid for 3 minutes
sign true String Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See Signature Generation Rules
itemCategory true String Billing item, required; seminarDuration: seminar participation duration; seminarRecordDuration: seminar recording duration; duration: live streaming minutes
startDate true String Start date, required, format: yyyy-MM-dd, cross-month queries not allowed
endDate true String End date, required, format: yyyy-MM-dd, cross-month queries not allowed
pageNumber false String Current page number
pageSize false String Page size

Example

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&timestamp=1691131787072

Response Parameters

Parameter Type Description
code Integer Status code, same as HTTP status code, used to determine basic response status
data Object See Data Parameter Description
error Object Error information when status code is not 200 See Error Parameter Description
requestId String Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, should not be tied to business logic
status String Response result, determined by business logic; returns success on success, error on failure
success Boolean Whether the response was successful

Data Parameter Description

Parameter Type Description
contents Array Paginated data collection See Contents Parameter Description
pageNumber Integer Current page number
pageSize Integer Page size
totalItems Integer Total number of records
totalPages Integer Total number of pages

Contents Parameter Description

Parameter Type Description
userId String Account ID
accountPeriod String Billing period, e.g., 2026-01
statAt String Billing date, e.g., 2026-01-01
useDate String Usage date, e.g., 2026-01-01
itemConsumed BigDecimal Usage amount
clearingItemConsumed BigDecimal Settlement amount
itemCategory String Billing item; seminarDuration: seminar participation duration; seminarRecordDuration: seminar recording duration
itemName String Item details, e.g., 1v6 meeting, etc.
production String Product
tradeType String Transaction type
cost BigDecimal Cost
status String Bill status, e.g., Paid
univalence long Unit price
univalenceUnit String Unit price unit
itemConsumedUnit String Usage unit

Error Parameter Description

Parameter Type Description
code Integer Error code, used to identify the specific error cause
desc String Error description, corresponding to error.code

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
  "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
  }
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询