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 端依據此物件處理業務邏輯；

請求參數說明

參數名	必填	類型	說明
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 端依據此物件處理業務邏輯；

請求參數說明

參數名	必填	類型	說明
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 端依據此物件處理業務邏輯；

請求參數說明

參數名	必填	類型	說明
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 端依據此物件處理業務邏輯；

請求參數說明

參數名	必填	類型	說明
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 端依據此物件處理業務邏輯；

請求參數說明

參數名	必填	類型	說明
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 端依據此物件處理業務邏輯；

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息見 PloyvSdkException.getMessage()，