保利威文档中心

帮助中心

直播JAVA SDK

childrenService

更新时间：2025-09-11 15:18:09

1、查询用户子账号列表

描述

查询用户子账号列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/children/list

调用约束

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

单元测试

    @Test
    public void testGetUserChildren() throws IOException, NoSuchAlgorithmException {
        LiveGetUserChildrenRequest liveGetUserChildrenRequest = new LiveGetUserChildrenRequest();
        LiveGetUserChildrenResponse liveGetUserChildrenResponse;
        try {
            liveGetUserChildrenRequest.setChildEmail("");
            liveGetUserChildrenResponse = new ILiveChildrenServiceImpl().getUserChildren(liveGetUserChildrenRequest);
            Assert.assertNotNull(liveGetUserChildrenResponse);
            if (liveGetUserChildrenResponse != null) {
                //to do something ......
                log.debug("测试查询用户子账号列表成功 {}", JSON.toJSONString(liveGetUserChildrenResponse));
            }
        } 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、请求正确，返回LiveGetUserChildrenResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

参数名 必选 类型 说明
childEmail false String 子账号邮箱，多个邮箱ID以,分隔，一次最多传入100个
currentPage false Integer 页数，默认为1【对应api文档的pageNumber字段】
pageSize false Integer 每页显示的数据条数，默认每页显示20条数据
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

参数名 类型 说明
contents Array 子账号信息【详见UserChildren参数描述】
pageSize Integer 每页显示的数据条数，默认每页显示20条数据
currentPage Integer 当前页【对应api文档的pageNumber字段】
totalItems Integer 记录总条数
totalPage Integer 总页数【对应api文档的totalPages字段】
UserChildren参数描述
参数名 类型 说明
childUserId String 子账号用户Id
childName String 子账号用户名
childEmail String 子账号邮箱
description String 描述
telephone String 手机号码
status String 状态 NORMAL：正常 FROZEN：冻结 DELETE：删除
organizationId Integer 所属用户组织架构ID
organizationName String 所属用户组织架构名称
roleId Integer 所属角色ID
roleName String 所属角色名称
createdTime Date 创建时间，13位毫秒级时间戳





2、新增子账号

描述

新增子账号
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/children/create

调用约束

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

单元测试

    @Test
    public void testCreateUserChildren() throws IOException, NoSuchAlgorithmException {
        LiveCreateUserChildrenRequest liveCreateUserChildrenRequest = new LiveCreateUserChildrenRequest();
        LiveCreateUserChildrenResponse liveCreateUserChildrenResponse;
        try {
            liveCreateUserChildrenRequest.setChildEmail(getRandomString(6) + "-paas-test@polyv.net")
                    .setChildName(getRandomString(6))
                    .setPassword(getRandomString(8))
                    .setRoleId(1);
            liveCreateUserChildrenResponse = new ILiveChildrenServiceImpl().createUserChildren(
                    liveCreateUserChildrenRequest);
            Assert.assertNotNull(liveCreateUserChildrenResponse);
            if (liveCreateUserChildrenResponse != null) {
                //to do something ......
                log.debug("测试新增子账号成功 {}", JSON.toJSONString(liveCreateUserChildrenResponse));
                //TODO 此处创建完成后删除了子账号，正式使用需删除该语句
                super.deleteUserChildren(liveCreateUserChildrenResponse.getChildEmail());
            }
        } 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、请求正确，返回LiveCreateUserChildrenResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

参数名 必选 类型 说明
childEmail true String 子账号登录邮箱
childName true String 子账号用户名称，最大长度50个字符
password true String 子账号密码，长度8~16位必须包含数字与字母
roleId true Integer 角色ID
organizationId false Integer 组织ID，不传分配默认组织：总部
telephone false String 手机号码
description false String 备注信息，最大长度100个字符
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

参数名 类型 说明
childUserId String 子账号用户Id
childName String 子账号用户名
childEmail String 子账号邮箱
description String 描述
telephone String 手机号码
status String 状态 NORMAL：正常 FROZEN：冻结 DELETE：删除
organizationId Integer 所属用户组织架构ID
organizationName String 所属用户组织架构名称
roleId Integer 所属角色ID
roleName String 所属角色名称
createdTime Date 创建时间





3、修改子账号

描述

通过子账号登录邮箱修改子账号信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/children/update

调用约束

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

单元测试

    @Test
    public void testUpdateUserChildren() throws IOException, NoSuchAlgorithmException {
        LiveUpdateUserChildrenRequest liveUpdateUserChildrenRequest = new LiveUpdateUserChildrenRequest();
        Boolean liveUpdateUserChildrenResponse;
        try {
            liveUpdateUserChildrenRequest.setChildEmail(super.getUserChildren().getChildEmail())
                    .setChildName("张三zs")
                    .setDescription("测试修改描述");
            liveUpdateUserChildrenResponse = new ILiveChildrenServiceImpl().updateUserChildren(
                    liveUpdateUserChildrenRequest);
            Assert.assertTrue(liveUpdateUserChildrenResponse);
            if (liveUpdateUserChildrenResponse) {
                //to do something ......
                log.debug("测试修改子账号成功");
            }
        } 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. ]

请求入参描述

参数名 必选 类型 说明
childEmail true String 子账号登录邮箱
childName false String 子账号用户名称，最大长度50个字符
password false String 子账号密码，长度8~16位必须包含数字与字母
roleId false Integer 角色ID
telephone false String 手机号码
description false String 备注信息，最大长度100个字符
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

修改子账号返回实体



4、删除子账号

描述

通过子账号登录邮箱删除子账号
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/children/delete

调用约束

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

单元测试

    @Test
    public void testDeleteUserChildren() throws IOException, NoSuchAlgorithmException {
        LiveDeleteUserChildrenRequest liveDeleteUserChildrenRequest = new LiveDeleteUserChildrenRequest();
        Boolean liveDeleteUserChildrenResponse;
        try {
            liveDeleteUserChildrenRequest.setChildEmail(super.getUserChildren().getChildEmail());
            liveDeleteUserChildrenResponse = new ILiveChildrenServiceImpl().deleteUserChildren(
                    liveDeleteUserChildrenRequest);
            Assert.assertTrue(liveDeleteUserChildrenResponse);
            if (liveDeleteUserChildrenResponse) {
                //to do something ......
                log.debug("测试删除子账号成功");
            }
        } 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. ]

请求入参描述

参数名 必选 类型 说明
childEmail true String 子账号邮箱
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

删除子账号返回实体



5、查询角色列表

描述

查询子账号角色权限列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/children/role/list

调用约束

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

单元测试

    @Test
    public void testGetChildrenRoleList() throws IOException, NoSuchAlgorithmException {
        LiveGetChildrenRoleListRequest liveGetChildrenRoleListRequest = new LiveGetChildrenRoleListRequest();
        List<LiveGetChildrenRoleListResponse> liveGetChildrenRoleListResponse;
        try {
            liveGetChildrenRoleListResponse = new ILiveChildrenServiceImpl().getChildrenRoleList(
                    liveGetChildrenRoleListRequest);
            Assert.assertNotNull(liveGetChildrenRoleListResponse);
            if (liveGetChildrenRoleListResponse != null) {
                //to do something ......
                log.debug("测试查询角色列表成功 {}", JSON.toJSONString(liveGetChildrenRoleListResponse));
            }
        } 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、请求正确，返回LiveGetChildrenRoleListResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

参数名 必选 类型 说明
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

返回对象是List<LiveGetChildrenRoleListResponse>，LiveGetChildrenRoleListResponse具体元素内容如下：

参数名 类型 说明
id Integer 角色ID
name String 角色名称
description String 角色描述，备注
permissionName String 权限名称，多个权限名称用英文逗号”,“分割





6、查询组织架构列表

描述

组织架构列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/organization/list

调用约束

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

单元测试

    @Test
    public void testGetOrganizationList() throws IOException, NoSuchAlgorithmException {
        LiveGetOrganizationListRequest liveGetOrganizationListRequest = new LiveGetOrganizationListRequest();
        List<LiveGetOrganizationListResponse> liveGetOrganizationListResponse;
        try {
            liveGetOrganizationListResponse = new ILiveChildrenServiceImpl().getOrganizationList(
                    liveGetOrganizationListRequest);
            Assert.assertNotNull(liveGetOrganizationListResponse);
            if (liveGetOrganizationListResponse != null) {
                //to do something ......
                log.debug("测试查询组织架构列表成功 {}", JSON.toJSONString(liveGetOrganizationListResponse));
            }
        } 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、请求正确，返回LiveGetOrganizationListResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

参数名 必选 类型 说明
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

返回对象是List<LiveGetOrganizationListResponse>，LiveGetOrganizationListResponse具体元素内容如下：

参数名 类型 说明
userId String 用户ID
id Integer 组织ID
name String 组织名称
description String 组织描述
icon String 图标
lft Integer 左节点
rgt Integer 右节点
parentId Integer 父级组织的左节点ID





7、新增组织

描述

组织架构新增子节点（排在第一位）
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/organization/create

调用约束

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

单元测试

    @Test
    public void testCreateOrganization() throws IOException, NoSuchAlgorithmException {
        LiveCreateOrganizationRequest liveCreateOrganizationRequest = new LiveCreateOrganizationRequest();
        LiveCreateOrganizationResponse liveCreateOrganizationResponse;
        try {
            liveCreateOrganizationRequest.setParentId(573).setName("测试组织001").setDescription("测试描述");
            liveCreateOrganizationResponse = new ILiveChildrenServiceImpl().createOrganization(
                    liveCreateOrganizationRequest);
            Assert.assertNotNull(liveCreateOrganizationResponse);
            if (liveCreateOrganizationResponse != null) {
                //to do something ......
                log.debug("测试新增组织成功 {}", JSON.toJSONString(liveCreateOrganizationResponse));
                //TODO 此处创建完成后删除了组织，正式使用需删除该语句
                super.deleteOrganization(liveCreateOrganizationResponse.getId());
            }
        } 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、请求正确，返回LiveCreateOrganizationResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

参数名 必选 类型 说明
parentId true Integer 父节点组织ID
name true String 组织架构名称，最大长度12个字符
description false String 组织描述，最大长度100个字符
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

参数名 类型 说明
userId String 用户ID
id Integer 组织ID
name String 组织名称
description String 组织描述
icon String 图标
lft Integer 左节点
rgt Integer 右节点
parentId Integer 父级组织的左节点ID





8、删除组织

描述

通过组织ID删除组织
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/user/organization/delete

调用约束

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

单元测试

    @Test
    public void testDeleteOrganization() throws IOException, NoSuchAlgorithmException {
        LiveDeleteOrganizationRequest liveDeleteOrganizationRequest = new LiveDeleteOrganizationRequest();
        Boolean liveDeleteOrganizationResponse;
        try {
            liveDeleteOrganizationRequest.setOrganizationId(2818);
            liveDeleteOrganizationResponse = new ILiveChildrenServiceImpl().deleteOrganization(
                    liveDeleteOrganizationRequest);
            Assert.assertNotNull(liveDeleteOrganizationResponse);
            if (liveDeleteOrganizationResponse != null) {
                //to do something ......
                log.debug("测试删除组织成功 {}", JSON.toJSONString(liveDeleteOrganizationResponse));
            }
        } 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. ]

请求入参描述

参数名 必选 类型 说明
organizationId true Integer 组织ID，组织节点或子孙节点若存在子账号则不允许删除，若该组织节点存在子孙节点将全部删除
appId false String POLYV用户APP_ID，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）
appSecret false String POLYV用户APP_SECRET，多账号调用时该参数必填（即调用了initMultiAccount()设置多账号调用），通过注册保利威官网获取，路径：官网->登录->直播（开发设置）

返回对象描述

删除组织返回实体

联系客服，在线咨询