查詢子帳號剩餘資源
更新時間:2022-11-25 09:24:58
介面描述
1、集团账号查询分账号剩余资源
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/group/user/package-validity/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret
3、已過期資源不會返回記錄
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 集團主帳號appId |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| emails | false | String | 子帳號信箱,多個用英文逗號分隔,最多100個 |
| pageSize | false | Integer | 每頁資料大小,預設10,最大值50 |
| pageNumber | false | Integer | 目前的頁數,預設1 |
範例
http://api.polyv.net/live/v4/group/user/package-validity/list?appId=gc3eo6bh28×tamp=1660214429000&sign=17A7D2304E85EA18A41C125D65E90DFC
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| userId | String | 使用者ID |
| appId | String | 子帳號應用ID |
| appSecret | String | 子帳號應用secret |
| String | 子帳號信箱 | |
| balance | String | 剩餘金額 |
| phone | String | 手機號碼 |
| memo | String | 備註 |
| contacts | String | 聯絡人 |
| chargeType | String | 雲直播計費類型 minutes:分鐘數 parallelConcurrent:並行並發 totalConcurrent:累計並發 |
| concurrent | Array | 雲直播並發數剩餘資源【詳見Resource欄位說明】 |
| minutes | Array | 雲直播分鐘數剩餘資源【詳見Resource欄位說明】 |
| flow | Array | 雲點播流量(bytes)剩餘資源【詳見Resource欄位說明】 |
| space | Array | 雲點播空間(bytes)剩餘資源【詳見Resource欄位說明】 |
| expireType | String | 到期時間類型 group:跟隨主帳號 custom:自訂 |
| expireDate | Long | 帳號到期時間,十三位時間戳 |
| status | String | 狀態 normal:正常使用 expired:已過期 frozen:已凍結 |
| linkMicMinutes | Integer | 可用連麥分鐘數 |
| guideMinutes | Integer | 可用雲導播台分鐘數 |
| maxChannels | Integer | 可建立頻道數 |
| linkMicLimit | Integer | 連麥人數 |
Resource參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| start | String | 開始時間,格式為yyyy-MM-dd,例如:2022-12-01 |
| end | String | 到期時間,格式為yyyy-MM-dd,例如:2022-12-10 |
| available | Long | 資源可用量 流量:位元組 空間:位元組 |
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 groupUserPackageListTest() 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/user/package-validity/list";
//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": "83991d6d866e4dafa2ed81f9946df302.54.16534840806930299",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"userId": "*******",
"appId": "*******",
"appSecret": "************",
"email": "*******@polyv.net",
"balance": "0",
"phone": "*******",
"memo": "aaa",
"chargeType": "minutes",
"concurrent": [],
"minutes": [
{
"start": "2022-11-22",
"end": "2022-12-05",
"available": 1100
},
{
"start": "2022-12-06",
"end": "2022-12-10",
"available": 100
}
],
"flow": [
{
"start": "2022-12-15",
"end": "2022-12-25",
"available": 2147483648
}
],
"space": [],
"expireDate": null,
"status": "normal",
"contacts": "测试",
"expireType": "group",
"linkMicMinutes": 0,
"guideMinutes": 0,
"maxChannels": 0,
"linkMicLimit": 1,
"pureRtcEnabled": "Y"
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
