查詢用戶套餐與資源資訊
更新時間:2026-07-13 18:28:45
介面說明
1、查询当前账号的直播套餐、点播套餐和增值资源信息
2、接口支持https协议
介面URL
https://api.polyv.net/live/v4/user/package-resource/get
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
範例
https://api.polyv.net/live/v4/user/package-resource/get?appId=frlr1zazn3×tamp=1720406400000&sign=14A0FA6A31D03D9D1164F55A14E6DB5B
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功回傳,非200為失敗 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 回應結果,由業務決定,成功回傳true,失敗回傳false |
| data | Object | 套餐與資源資訊【詳見data欄位說明】 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位說明】 |
| requestId | String | 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應與業務掛鉤 |
Error參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
data參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| resourcePointSettlement | String | 資源點結算開關,Y:開啟,N:關閉 |
| balance | Number | 帳戶餘額,單位元 |
| resourcePointBalance | Number | 資源點餘額 |
| arrearage | Number | 欠費金額,單位元 |
| totalCredit | Number | 授信額度,單位元 |
| validCredit | Number | 授信餘額,單位元 |
| products | Object | 產品服務資訊【詳見products欄位說明】 |
| accretionts | Object | 加值服務資訊【詳見accretionts欄位說明】 |
products參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| cloudLive | Object | 雲直播套餐資訊【詳見cloudLive欄位說明】 |
| cloudVod | Object | 雲點播套餐資訊【詳見cloudVod欄位說明】 |
cloudLive參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| name | String | 套餐名稱 |
| startDate | String | 套餐開始日期,格式:yyyy-MM-dd |
| endDate | String | 套餐到期日期,格式:yyyy-MM-dd |
| billingPlan | String | 套餐計費方式,回傳 duration、concurrent等 |
| availableResource | Number | 目前計費方式下的可用資源值【詳見直播資源說明】 |
| remainingDays | Integer | 套餐剩餘天數 |
| maxChannelCount | Integer | 可建立頻道總數 |
| availableChannelCount | Integer | 剩餘可建立頻道數 |
cloudVod參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| name | String | 套餐名稱 |
| startDate | String | 套餐開始日期,格式:yyyy-MM-dd |
| endDate | String | 套餐到期日期,格式:yyyy-MM-dd |
| validTraffic | Number | 剩餘流量,單位GB |
| validSpace | Number | 剩餘空間,單位GB |
| remainingDays | Integer | 套餐剩餘天數 |
accretionts參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| items | Array | 加值資源列表【詳見items欄位說明】 |
items參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| key | String | 資源項列舉值,如 GUIDE_PLATE、LINK_MIC、DISTRIBUTE、ASR_ENABLED、AI_ASSISTANT |
| desc | String | 資源項中文名稱,如雲導播台、雲直播-連麥、雲分發、即時字幕(原聲)、AI助手答疑 |
| unit | String | value 欄位單位,如分鐘、次、字元 |
| enabled | String | 是否開通,Y:已開通,N:未開通 |
| value | Number | 剩餘可用量,單位根據資源項不同而不同 |
直播資源說明
cloudLive.availableResource 會根據 billingPlan 回傳對應的可用資源值:
| billingPlan | availableResource 含義 |
|---|---|
| duration | 可用直播分鐘數 |
| concurrent | 並發類可用資源,可用並發數 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼,點擊下載原始碼,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
* 查询用户套餐和资源信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetPackageResource() throws IOException, NoSuchAlgorithmException {
// 公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
// 业务参数
String url = "https://api.polyv.net/live/v4/user/package-resource/get";
// http调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询用户套餐和资源信息成功:{}", response);
// do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "7bd56e99-3705-4bb0-9834-a0201eebcc4a",
"data": {
"resourcePointSettlement": "Y",
"balance": 100.00,
"resourcePointBalance": 50.00,
"arrearage": 0.00,
"totalCredit": 0.00,
"validCredit": 0.00,
"products": {
"cloudLive": {
"name": "企业直播专业版",
"startDate": "2026-01-01",
"endDate": "2026-09-01",
"billingPlan": "duration",
"availableResource": 1200,
"remainingDays": 55,
"maxChannelCount": 20,
"availableChannelCount": 12
},
"cloudVod": {
"name": "点播存储套餐",
"startDate": "2026-01-01",
"endDate": "2026-09-01",
"validTraffic": 500.00,
"validSpace": 300.00,
"remainingDays": 55
}
},
"accretionts": {
"items": [
{
"key": "GUIDE_PLATE",
"desc": "云导播台",
"unit": "分钟",
"enabled": "Y",
"value": 300
},
{
"key": "LINK_MIC",
"desc": "云直播-连麦",
"unit": "分钟",
"enabled": "Y",
"value": 120
},
{
"key": "DISTRIBUTE",
"desc": "云分发",
"unit": "次",
"enabled": "N",
"value": 0
},
{
"key": "AI_ASSISTANT",
"desc": "AI助手答疑",
"unit": "字符",
"enabled": "Y",
"value": 1000
}
]
}
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
