保利威文档中心

帮助中心

userService

更新时间:2023-07-11 15:01:53

1、查询分账号列表及剩余资源

描述

集团账号查询分账号列表及分账号剩余资源
接口地址(仅做说明使用):https://api.polyv.net/live/v4/group/user/package/list

调用约束

1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看

单元测试

    @Test
    public void testListPackage() throws IOException, NoSuchAlgorithmException {
        GroupListPackageRequest groupListPackageRequest = new GroupListPackageRequest();
        GroupListPackageResponse groupListPackageResponse;
        try {
            groupListPackageResponse = new UserServiceImpl().listPackage(groupListPackageRequest);
            Assert.assertNotNull(groupListPackageResponse);
            if (groupListPackageResponse != null) {
                //to do something ......
                log.debug("测试查询分账号列表及剩余资源成功 {}", JSON.toJSONString(groupListPackageResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确,返回GroupListPackageResponse对象,B端依据此对象处理业务逻辑;

2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]

请求入参描述

参数名 必选 类型 说明
emails false String 分账号邮箱,多个用英文逗号分隔,最多100个
pageSize false Integer 每页数据大小,默认10,最大值100
pageNumber false Integer 当前的页数,默认1

返回对象描述

参数名 类型 说明
contents Array 账单列表【详见Package参数描述
pageSize Integer 每页显示的数据条数,默认每页显示20条数据
currentPage Integer 当前页【对应api文档的pageNumber字段】
totalItems Integer 记录总条数
totalPage Integer 总页数【对应api文档的totalPages字段】
Package参数描述
参数名 类型 说明
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






2、创建集团分帐号

描述

创建集团分帐号
接口地址(仅做说明使用):https://api.polyv.net/live/v4/group/user/create

调用约束

1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看

单元测试

    @Test
    public void testCreate() throws IOException, NoSuchAlgorithmException {
        GroupCreateUserRequest groupCreateUserRequest = new GroupCreateUserRequest();
        GroupCreateUserResponse groupCreateUserResponse;
        try {
            groupCreateUserRequest.setEmail("polyvtest0707@polyv.net");
            groupCreateUserRequest.setPassword("polyvtest0707");
            groupCreateUserRequest.setContacts("张三");
            groupCreateUserRequest.setPhone("17600002222");
            groupCreateUserRequest.setExpireDate(super.getDate(1688720314000L));
            groupCreateUserRequest.setMaxChannels(1);
            groupCreateUserRequest.setConcurrent(10);
            groupCreateUserResponse = new UserServiceImpl().create(groupCreateUserRequest);
            Assert.assertNotNull(groupCreateUserResponse);
            if (groupCreateUserResponse != null) {
                //to do something ......
                log.debug("测试创建集团分帐号成功 {}", JSON.toJSONString(groupCreateUserResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确,返回GroupCreateUserResponse对象,B端依据此对象处理业务逻辑;

2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]

请求入参描述

参数名 必选 类型 说明
email true String 邮箱
password true String 密码,需要同时包含数字、英文,长度8~32位
contacts true String 联系人
phone true String 手机号码,手机号不能绑定超过3个邮箱
maxChannels true Integer 最多可创建频道数量
minutes false Integer 分钟数,主账号为分钟数计费,该用量值必填
concurrent false Integer 并发数,主账号为并发计费,该用量值必填
balance false Float 金额,不能小于0
memo false String 备注,50字符长度
expireType false String 到期时间类型 group:跟随主账号 custom:自定义
expireDate false Date 账号过期时间,yyyy-MM-dd,如2022-04-28
remainFlow false Integer 点播流量,单位G,默认分配100G
remainSpace false Integer 点播空间,单位G,默认分配100G

返回对象描述

参数名 类型 说明
appId String 应用ID
appSecret String 应用Secret
userId String 用户全局ID






3、分配分帐号资源

描述

分配分帐号资源
接口地址(仅做说明使用):https://api.polyv.net/live/v4/group/user/package/update

调用约束

1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看

单元测试

    @Test
    public void testUpdatePackage() throws IOException, NoSuchAlgorithmException {
        GroupUpdatePackageRequest groupUpdatePackageRequest = new GroupUpdatePackageRequest();
        Boolean groupUpdatePackageResponse;
        try {
            groupUpdatePackageRequest.setEmail("polyvtest0625@polyv.net");
            groupUpdatePackageRequest.setBalance(2f);
            groupUpdatePackageRequest.setConcurrent(5);
            groupUpdatePackageRequest.setRemainFlow(10);
            groupUpdatePackageRequest.setRemainSpace(10);
            groupUpdatePackageResponse = new UserServiceImpl().updatePackage(groupUpdatePackageRequest);
            Assert.assertNotNull(groupUpdatePackageResponse);
            if (groupUpdatePackageResponse != null) {
                //to do something ......
                log.debug("测试分配分帐号资源成功 {}", JSON.toJSONString(groupUpdatePackageResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

单元测试说明

1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;

2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]

请求入参描述

参数名 必选 类型 说明
email true String 分帐号邮箱
balance false Float 金额,不能小于0
concurrent false Integer 并发数
minutes false Integer 可用分钟数(分)
remainFlow false Integer 点播流量,单位G
remainSpace false Integer 点播空间,单位G
linkMicLimit false Integer 连麦人数限制,最多16人
linkMicMinutes false Integer 连麦分钟数
guideMinutes false Integer 云导播台分钟数
maxChannels false Integer 可创建频道数

返回对象描述

true为分配成功,false为分配失败

联系客服,在线咨询