分配子帳號資源
更新時間:2025-12-04 23:21:05
介面描述
1、分配分帐号资源
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
介面URL
http://api.polyv.net/live/v4/group/user/package/update
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret
3、子帳號用量計費套餐跟隨集團主帳號,分鐘數計費只能分配分鐘數,並發計費只能分配並發數
請求參數描述
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 集團主帳號appId【詳見集團帳號2.0取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在客戶端直接使用,所有API都必須透過客戶自己伺服器轉發呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
請求體參數描述
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| true | String | 子帳號信箱 | |
| accumulateResource | false | String | 是否累加資源,可選值有: Y: 在原有資源基礎上累加資源 N: 不累加資源,直接設定、替換為目標值 不傳值時,預設為N。 請注意,部分資源僅支援替換,不支援累加處理,詳見下面的欄位說明。 |
| balance | false | Float | 金額(元),不能小於0,最高精確到兩位小數,例如 1.23 |
| concurrent | false | Integer | 直播並發數 |
| minutes | false | Integer | 直播可用分鐘數(分鐘) |
| linkMicMinutes | false | Integer | 直播連麥分鐘數(分鐘) |
| guideMinutes | false | Integer | 直播導播檯分鐘數(分鐘) |
| maxChannels | false | Integer | 直播可建立頻道數 |
| remainFlow | false | Integer | 點播流量 (GB) |
| remainSpace | false | Integer | 點播空間 (GB) |
| linkMicLimit | false | Integer | 連麥人數限制,最多16人 請注意,該資源不支援累加,即 accumulateResource=Y 參數對該欄位無效 |
| aiPptVideoDuration | false | Integer | 分配影片創作分鐘數,小於0表示回收資源。 請注意,該資源僅支援累加,即 accumulateResource=N 參數對該欄位無效 |
| aiPptVideoWithDigitalHumanDuration | false | Integer | 分配影片創作(含數位人),小於0表示回收資源。 請注意,該資源僅支援累加,即 accumulateResource=N 參數對該欄位無效 |
範例
http://api.polyv.net/live/v4/group/user/package/update?appId=g8dtv537aq×tamp=1653485584000&sign=C84658AB04C262A71AA1417168828719
請求體參數
{
"email": "********@polyv.net",
"minutes": 500,
"maxChannels":10
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Boolean | 請求成功回傳true,請求失敗回傳空 |
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(ChannelOperateTest.class);
/**
* 分配分帐号资源
*/
@Test
public void groupUserPackageTest() 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/update";
String email = "polyvtest123456@polyv.net";
String balance = "10";
String concurrent = "101";
String remainFlow = "20";
String remainSpace = "20";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("email", email);
jsonMap.put("balance", balance);
jsonMap.put("concurrent", concurrent);
jsonMap.put("remainFlow", remainFlow);
jsonMap.put("remainSpace", remainSpace);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
log.info("测试分配分帐号资源成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "71c487ed89a94ca0b29e8779ea96f84b.63.16529473248590749",
"data": true,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
