分配分帐号资源
更新时间: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
}
