> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/live/api/v-4/group/user/package_list.md).
# 查询分账号列表及剩余资源
### 接口描述
```
1、集团账号查询分账号列表及分账号剩余资源
2、接口支持https协议
```
### 接口URL
```
http://api.polyv.net/live/v4/group/user/package/list
```
[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/group/user/package/list/README.md)
### 请求方式
```
GET
```
### 接口约束
1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)
2、集团账号接口计算签名请使用集团主账号的appId、appSecret
### 请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
| ---------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId | true | String | 集团主账号appId【详见[集团账号2.0获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getGroupSecretKey/README.md)】 |
| timestamp | true | Long | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| emails | false | String | 分账号邮箱，多个用英文逗号分隔，最多100个 |
| pageSize | false | Integer | 每页数据大小，默认10，最大值100 |
| pageNumber | false | Integer | 当前的页数，默认1 |
### 示例
```requestUrl
http://api.polyv.net/live/v4/group/user/package/list?appId=g8dtv537aq×tamp=1653484715000&sign=6C95C3A3E93D46A78A86DCDB8930D70A
```
### 响应参数描述
| 参数名 | 类型 | 说明 |
| --------- | ------- | ---------------------------------------- |
| code | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态 |
| status | String | 响应结果，由业务决定，成功返回success，失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见[Error字段描述](#error参数描述)】 |
| data | Object | 账单列表【详见[data字段说明](#data参数描述)】 |
### Error参数描述
| 参数名 | 类型 | 说明 |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因 |
| desc | String | 错误描述，与 error.code 对应 |
### Data参数描述
| 参数名 | 类型 | 说明 |
| ---------- | ------- | -------------------------------------- |
| pageNumber | Integer | 当前页码 |
| pageSize | Integer | 每页数据量 |
| totalPages | Long | 页面总数 |
| totalItems | Long | 总数据量 |
| contents | Array | 当前页内容【详见[contents字段说明](#contents参数描述)】 |
### Contents参数描述
| 参数名 | 类型 | 说明 |
| ---------------- | ------- | -------------------------------------------------------------------------------- |
| userId | String | 用户ID |
| appId | String | 分帐号应用ID |
| appSecret | String | 分帐号应用secret |
| email | String | 分帐号邮箱 |
| balance | String | 剩余金额 |
| phone | String | 手机号码 |
| memo | String | 备注 |
| contacts | String | 联系人 |
| chargeType | String | 云直播计费类型
minutes：分钟数
parallelConcurrent：并行并发
totalConcurrent：累计并发
|
| remainConcurrent | Long | 云直播剩余资源，并发 |
| remainMinutes | Long | 云直播剩余资源，可用直播分钟数 |
| remainFlow | Float | 云点播剩余资源，流量(G) |
| remainSpace | Float | 云点播剩余资源，空间(G) |
| expireType | String | 到期时间类型
group：跟随主账号
custom：自定义
|
| expireDate | Long | 账号到期时间，十三位时间戳 |
| status | String | 状态
normal：正常使用
expired：已过期
frozen：已冻结
|
| linkMicMinutes | Integer | 可用连麦分钟数 |
| guideMinutes | Integer | 可用云导播台分钟数 |
| maxChannels | Integer | 可创建频道数 |
| linkMicLimit | Integer | 连麦人数 |
| vodSecretKey | String | 点播secretkey |
| vodBakSecretKey | String | 点播备用secretkey |
| writeToken | String | 点播writetoken |
| readToken | String | 点播readtoken |
### Java请求示例
快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。
> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
```java
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/list";
//http 调用逻辑
Map 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
}
```
### 响应示例
系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)
成功示例
```json
{
"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",
"remainConcurrent": 0,
"remainMinutes": 100,
"remainFlow": 100.0,
"remainSpace": 100.0,
"expireDate": 1652803200000,
"status": "normal",
"contacts": "aaa",
"expireType": "group",
"linkMicMinutes": 100,
"guideMinutes": 100,
"maxChannels": 10,
"linkMicLimit": 6,
"pureRtcEnabled": "N",
"vodSecretKey": "*******",
"vodBakSecretKey": "*******",
"writeToken": "*******-*******-*******-*******-*******",
"readToken": "*******-*******-*******-*******-*******"
}
]
},
"success": true
}
```
异常示例
```json
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
```