channelService

1. Create Seminar Channel (Legacy Backend)

Description

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

Call Constraints

1. The API call has a frequency limit. See details. For common call exceptions, see details.

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a SeminarCreateChannelResponse object, based on which the B-side handles the business logic.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

BasicSetting Parameter Description

AuthSetting Parameter Description

InfoField Parameter Description

Return Object Description

2. Create a Seminar Channel (New Backend)

Description

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

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/seminar/java/limit.md]. For common call exceptions, please refer to [/seminar/java/exceptionDoc].

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a SeminarCreateChannelV2Response object, and the B-side processes the business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found in PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

3. Get Webinar Channel Recording Settings

Description

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

Call Constraints

1. API calls are subject to rate limits. For details, see here. For common call exceptions, see here.

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a SeminarGetRecordSettingResponse object, based on which the B-side processes business logic.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

4. Modify Seminar Channel Recording Settings

Description

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

Call Constraints

1. The API call has a frequency limit. For details, see here. For common call exceptions, see here.

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed fields [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Modify the return entity for the webinar channel recording settings.

5. Retrieve Attendee Statistics for Seminar Live Room

Description

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

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/seminar/java/limit.md]. For common call exceptions, please refer to [/seminar/java/exceptionDoc].

Unit Testing

    @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;
        }
    }

Unit Testing Description

1. If the request is correct, a SeminarGetViewLogResponse object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed fields [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

ViewLog Parameter Description

6. Retrieve Live Room Audience Statistics

Description

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

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/seminar/java/limit.md]. For common call exceptions, please refer to [/seminar/java/exceptionDoc].

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a SeminarGetCdnViewLogResponse object, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

ViewLog Parameter Description

7. Delete a Single Channel

Description

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

Call Constraints

1. The API call has a frequency limit. For details, please refer to [/seminar/java/limit.md]. For common call exceptions, please refer to [/seminar/java/exceptionDoc].

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Delete Single Channel Return Entity

8. Batch Delete Channels

Description

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

Call Constraints

1. The API call has a frequency limit. Click here for details. For common call exceptions, click here for details.

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Batch Delete Channel Return Entity

9. Query Seminar Meeting Type

Description

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

Call Constraints

1. The API call has a frequency limit. For details, please refer to [/seminar/java/limit.md]. For common call exceptions, please refer to [/seminar/java/exceptionDoc].

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, return a SeminarGetLiveTypeResponse object, based on which the B-side processes the business logic.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found in PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

10. Modify Seminar Meeting Type

Description

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

Call Constraints

1. The API call is subject to frequency limits. For details, please refer to [/seminar/java/limit.md]. For common call exceptions, please refer to [/seminar/java/exceptionDoc].

Unit Testing

    @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;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned. The B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed fields [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

Modify the return entity for the seminar meeting type