channelService

1、创建研讨会频道(旧版后台)

描述

创建频道并进行相关设置
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/basic/create

调用约束

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

单元测试

    @Test
    public void testCreateChannel() throws IOException, NoSuchAlgorithmException {
        SeminarCreateChannelRequest seminarCreateChannelRequest = new SeminarCreateChannelRequest();
        SeminarCreateChannelResponse seminarCreateChannelResponse;
        try {
            SeminarCreateChannelRequest.BasicSetting basicSetting = new SeminarCreateChannelRequest.BasicSetting();
            basicSetting.setName("测试SDK创建研讨会")
                    .setChannelPasswd(super.getRandomString(6))
                    .setCategoryId(super.getCategory());
            SeminarCreateChannelRequest.AuthSetting authSetting = new SeminarCreateChannelRequest.AuthSetting();
            authSetting.setRank(1)
                    .setEnabled(SeminarConstant.Flag.YES.getFlag())
                    .setAuthType(SeminarConstant.AuthType.CODE.getCode())
                    .setAuthCode("123");
            seminarCreateChannelRequest.setBasicSetting(basicSetting).setAuthSettings(Arrays.asList(authSetting));
            seminarCreateChannelResponse = new SeminarChannelServiceImpl().createChannel(seminarCreateChannelRequest);
            Assert.assertNotNull(seminarCreateChannelResponse);
            if (seminarCreateChannelResponse != null) {
                //to do something ......
                log.debug("测试创建研讨会频道(旧版后台)成功 {}", JSON.toJSONString(seminarCreateChannelResponse));
                //TODO 此处创建完成后删除了频道，正式使用需删除该语句
                super.deleteChannel(seminarCreateChannelResponse.getChannelId());
            }
        } 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、请求正确，返回SeminarCreateChannelResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

BasicSetting参数描述

AuthSetting参数描述

InfoField参数描述

返回对象描述

2、创建研讨会频道(新版后台)

描述

根据直播默认模板创建频道
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/channel/create

调用约束

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

单元测试

    @Test
    public void testCreateChannelV2() throws IOException, NoSuchAlgorithmException {
        SeminarCreateChannelV2Request seminarCreateChannelV2Request = new SeminarCreateChannelV2Request();
        SeminarCreateChannelV2Response seminarCreateChannelV2Response;
        try {
            seminarCreateChannelV2Request.setName("测试SDK创建研讨会")
                    .setSeminarHostPassword(super.getRandomString(6))
                    .setSeminarAttendeePassword(super.getRandomString(8))
                    .setCategoryId(super.getCategory())
                    .setStartTime(super.getDate(System.currentTimeMillis() + 600 * 1000))
                    .setLinkMicLimit(15);
            seminarCreateChannelV2Response = new SeminarChannelServiceImpl().createChannelV2(
                    seminarCreateChannelV2Request);
            Assert.assertNotNull(seminarCreateChannelV2Response);
            if (seminarCreateChannelV2Response != null) {
                //to do something ......
                log.debug("测试创建研讨会频道(新版后台)成功 {}", JSON.toJSONString(seminarCreateChannelV2Response));
                //TODO 此处创建完成后删除了频道，正式使用需删除该语句
                super.deleteChannel(String.valueOf(seminarCreateChannelV2Response.getChannelId()));
            }
        } 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、请求正确，返回SeminarCreateChannelV2Response对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

返回对象描述

3、获取研讨会频道录制设置

描述

获取研讨会频道录制设置
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/seminar/setting/get-record

调用约束

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

单元测试

    @Test
    public void testGetRecordSetting() throws IOException, NoSuchAlgorithmException {
        SeminarGetRecordSettingRequest seminarGetRecordSettingRequest = new SeminarGetRecordSettingRequest();
        SeminarGetRecordSettingResponse seminarGetRecordSettingResponse;
        try {
            String channelId = super.getChannelId();
            seminarGetRecordSettingRequest.setChannelId(channelId);
            seminarGetRecordSettingResponse = new SeminarChannelServiceImpl().getRecordSetting(
                    seminarGetRecordSettingRequest);
            Assert.assertNotNull(seminarGetRecordSettingResponse);
            if (seminarGetRecordSettingResponse != null) {
                //to do something ......
                log.debug("测试获取研讨会频道录制设置成功 {}", JSON.toJSONString(seminarGetRecordSettingResponse));
            }
        } 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、请求正确，返回SeminarGetRecordSettingResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

返回对象描述

4、修改研讨会频道录制设置

描述

修改研讨会频道录制设置
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/seminar/setting/set-record

调用约束

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

单元测试

    @Test
    public void testSetRecordSetting() throws IOException, NoSuchAlgorithmException {
        SeminarSetRecordSettingRequest seminarSetRecordSettingRequest = new SeminarSetRecordSettingRequest();
        Boolean seminarSetRecordSettingResponse;
        try {
            String channelId = super.getChannelId();
            seminarSetRecordSettingRequest.setChannelId(channelId)
                    .setRecordMode(SeminarConstant.RecordMode.manual.getModel())
                    .setEnabled(SeminarConstant.Flag.YES.getFlag());
            seminarSetRecordSettingResponse = new SeminarChannelServiceImpl().setRecordSetting(
                    seminarSetRecordSettingRequest);
            Assert.assertTrue(seminarSetRecordSettingResponse);
            if (seminarSetRecordSettingResponse) {
                //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. ]

请求入参描述

返回对象描述

修改研讨会频道录制设置返回实体

5、获取研讨会直播间参会者统计数据

描述

获取研讨会直播间参会者统计数据
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/seminar/statistics/listViewLogs

调用约束

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

单元测试

    @Test
    public void testGetViewLog() throws IOException, NoSuchAlgorithmException {
        SeminarGetViewLogRequest seminarGetViewLogRequest = new SeminarGetViewLogRequest();
        SeminarGetViewLogResponse seminarGetViewLogResponse;
        try {
            String channelId = super.getChannelId();
            seminarGetViewLogRequest.setChannelId(channelId)
                    .setStartTime(super.getDate(System.currentTimeMillis() - 20 * 86400000))
                    .setEndTime(super.getDate(System.currentTimeMillis()))
                    .setPageSize(20)
                    .setCurrentPage(1);
            seminarGetViewLogResponse = new SeminarChannelServiceImpl().getViewLog(seminarGetViewLogRequest);
            Assert.assertNotNull(seminarGetViewLogResponse);
            if (seminarGetViewLogResponse != null) {
                //to do something ......
                log.debug("测试获取研讨会直播间参会者统计数据成功 {}", JSON.toJSONString(seminarGetViewLogResponse));
            }
        } 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、请求正确，返回SeminarGetViewLogResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

返回对象描述

ViewLog参数描述

6、获取直播间观众统计数据

描述

获取直播间观众统计数据
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/statistics/listViewLogs

调用约束

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

单元测试

    @Test
    public void testGetCdnViewLog() throws IOException, NoSuchAlgorithmException {
        SeminarGetCdnViewLogRequest seminarGetCdnViewLogRequest = new SeminarGetCdnViewLogRequest();
        SeminarGetCdnViewLogResponse seminarGetCdnViewLogResponse;
        try {
            String channelId = super.getChannelId();
            seminarGetCdnViewLogRequest.setChannelId(channelId)
                    .setStartTime(super.getDate(System.currentTimeMillis() + 600 * 1000))
                    .setEndTime(super.getDate(System.currentTimeMillis() + 600 * 1000));
            seminarGetCdnViewLogResponse = new SeminarChannelServiceImpl().getCdnViewLog(seminarGetCdnViewLogRequest);
            Assert.assertNotNull(seminarGetCdnViewLogResponse);
            if (seminarGetCdnViewLogResponse != null) {
                //to do something ......
                log.debug("测试获取直播间观众统计数据成功 {}", JSON.toJSONString(seminarGetCdnViewLogResponse));
            }
        } 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、请求正确，返回SeminarGetCdnViewLogResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

返回对象描述

ViewLog参数描述

7、删除单个频道

描述

删除单个直播频道
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channels/%s/delete

调用约束

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

单元测试

    @Test
    public void testDeleteChannel() throws IOException, NoSuchAlgorithmException {
        SeminarDeleteChannelRequest seminarDeleteChannelRequest = new SeminarDeleteChannelRequest();
        Boolean seminarDeleteChannelResponse;
        try {
            seminarDeleteChannelRequest.setChannelId("2801915");
            seminarDeleteChannelResponse = new SeminarChannelServiceImpl().deleteChannel(seminarDeleteChannelRequest);
            Assert.assertTrue(seminarDeleteChannelResponse);
            if (seminarDeleteChannelResponse) {
                //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. ]

请求入参描述

返回对象描述

删除单个频道返回实体

8、批量删除频道

描述

批量删除直播频道，如果响应失败，则表示全部频道都失败，不会有部份成功、部份失败的结果
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/basic/batch-delete

调用约束

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

单元测试

    @Test
    public void testBatchDeleteChannel() throws IOException, NoSuchAlgorithmException {
        SeminarBatchDeleteChannelRequest seminarBatchDeleteChannelRequest = new SeminarBatchDeleteChannelRequest();
        Boolean seminarBatchDeleteChannelResponse;
        try {
            seminarBatchDeleteChannelRequest.setChannelIds(Arrays.asList("2802164", "2798162"));
            seminarBatchDeleteChannelResponse = new SeminarChannelServiceImpl().batchDeleteChannel(
                    seminarBatchDeleteChannelRequest);
            Assert.assertTrue(seminarBatchDeleteChannelResponse);
            if (seminarBatchDeleteChannelResponse) {
                //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. ]

请求入参描述

返回对象描述

批量删除频道返回实体

9、查询研讨会会议类型

描述

查询研讨会会议类型
接口地址（仅做说明使用）：https://api.polyv.net/meet/v1/channel/live-type/get

调用约束

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

单元测试

    @Test
    public void testGetLiveType() throws IOException, NoSuchAlgorithmException {
        SeminarGetLiveTypeRequest seminarGetLiveTypeRequest = new SeminarGetLiveTypeRequest();
        SeminarGetLiveTypeResponse seminarGetLiveTypeResponse;
        try {
            String channelId = super.getChannelId();
            seminarGetLiveTypeRequest.setChannelId(channelId);
            seminarGetLiveTypeResponse = new SeminarChannelServiceImpl().getLiveType(seminarGetLiveTypeRequest);
            Assert.assertNotNull(seminarGetLiveTypeResponse);
            if (seminarGetLiveTypeResponse != null) {
                //to do something ......
                log.debug("测试查询研讨会会议类型成功 {}", JSON.toJSONString(seminarGetLiveTypeResponse));
            }
        } 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、请求正确，返回SeminarGetLiveTypeResponse对象，B端依据此对象处理业务逻辑；

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

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

请求入参描述

返回对象描述

10、修改研讨会会议类型

描述

修改研讨会会议类型
接口地址（仅做说明使用）：https://api.polyv.net/meet/v1/channel/live-type/update

调用约束

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

单元测试

    @Test
    public void testUpdateLiveType() throws IOException, NoSuchAlgorithmException {
        SeminarUpdateLiveTypeRequest seminarUpdateLiveTypeRequest = new SeminarUpdateLiveTypeRequest();
        Boolean seminarUpdateLiveTypeResponse;
        try {
            String channelId = super.getChannelId();
            seminarUpdateLiveTypeRequest.setChannelId(channelId);
            seminarUpdateLiveTypeRequest.setSeminarLiveType("private");
            seminarUpdateLiveTypeResponse = new SeminarChannelServiceImpl().updateLiveType(
                    seminarUpdateLiveTypeRequest);
            Assert.assertNotNull(seminarUpdateLiveTypeResponse);
            if (seminarUpdateLiveTypeResponse != null) {
                //to do something ......
                log.debug("测试修改研讨会会议类型成功 {}", JSON.toJSONString(seminarUpdateLiveTypeResponse));
            }
        } 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. ]

请求入参描述

返回对象描述

修改研讨会会议类型返回实体