保利威文档中心

帮助中心

查询分账号剩余资源

更新时间: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&timestamp=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
email 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
}
联系客服,在线咨询