保利威文档中心

幫助中心

查詢用戶帳單詳情資料

更新時間:2026-04-24 09:32:47

介面描述

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

2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

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&timestamp=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
}
联系客服,在线咨询