保利威文档中心

幫助中心

查詢主帳號帳單統計

更新時間:2023-07-07 11:51:43

介面描述

1、集团账号查询主账号账单
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/group/account/billing-daily/list

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看

2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret

3、帳期傳入時間需在202204以後

請求參數描述

參數名 必選 類型 說明
appId true String 集團主帳號appId【詳見集團帳號2.0取得金鑰
timestamp true Long 目前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
billingDate true String 帳期,格式yyyyMM,例如202205,時間需在202204以後
pageSize false Integer 每頁資料大小,預設10,最大值1000
pageNumber false Integer 目前的頁數,預設1

範例

http://api.polyv.net/live/v4/group/account/billing-daily/list?appId=g8dtv537aq&timestamp=1653485867000&sign=32389FC010815EDE76028D587FFA6FB3&billingDate=202205

回應參數描述

參數名 類型 說明
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請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼,下載後加入自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询主账号账单统计
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupAccountBillingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.groupAppId;
    String appSecret = super.groupAppSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/group/account/billing-daily/list";
    String billingDate = "202205";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("billingDate", billingDate);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询主账号账单统计成功:{}", response);
    //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "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
}
联系客服,在线咨询