查询用户套餐和资源信息
更新时间: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
}
