chatRoomService

1、批次匯入頻道禁止詞

描述

批量导入频道严禁词
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/chat/%s/addBadWords

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testAddBadWord() throws Exception, NoSuchAlgorithmException {
        LiveBadWordRequest liveBadWordRequest = new LiveBadWordRequest();
        LiveBadWordResponse liveBadWordResponse = null;
        try {
            String channelId = super.createChannel();
            liveBadWordRequest.setChannelId(channelId).setWords(Arrays.asList(new String[]{"微信号", "手机号", "QQ号"}));
            liveBadWordResponse = new LiveChatRoomServiceImpl().addBadWord(liveBadWordRequest);
            Assert.assertNotNull(liveBadWordResponse);
            if (liveBadWordResponse != null) {
                //to do something ......
                log.debug("测试批量导入频道严禁词成功{}", JSON.toJSONString(liveBadWordResponse));
            }
        } 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、請求正確，回傳 LiveBadWordResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

回傳物件描述

2、查詢歷史聊天資訊

描述

查询一段时间内的聊天记录，时间格式为yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss。如未提交具体时间，只提交了日期，开始时间默认为日期当天的 00:00:00，结束时间为日期当天的23:59:59
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/get-history-page

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetHistoryChatMsg() throws Exception, NoSuchAlgorithmException {
        LiveGetMessageListRequest liveGetMessageListRequest = new LiveGetMessageListRequest();
        LiveGetMessageListResponse liveGetMessageListResponses;
        try {
            String channelId = super.createChannel();
            liveGetMessageListRequest.setChannelId(channelId)
                    .setStartDay(getDate(2020, 10, 01))
                    .setEndDay(getDate(2099, 12, 12))
                    .setStatus("pass")
                    .setPageSize(5)
                    .setCurrentPage(3);
            liveGetMessageListResponses = new LiveChatRoomServiceImpl().getPageHistoryChatMsg(
                    liveGetMessageListRequest);
            Assert.assertNotNull(liveGetMessageListResponses);
            if (liveGetMessageListResponses != null) {
                //to do something ......
                log.debug("测试查询历史聊天信息成功{}", JSON.toJSONString(liveGetMessageListResponses));
            }
        } 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、請求正確，回傳 LiveGetMessageListResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請參閱 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

回傳物件描述

MessageList參數描述

MessageListUser參數描述

3、查詢聊天室管理員資訊

描述

查询聊天室管理员信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/get-chat-admin

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChatAdminData() throws Exception, NoSuchAlgorithmException {
        LiveGetChatAdminDataRequest liveGetChatAdminDataRequest = new LiveGetChatAdminDataRequest();
        LiveGetChatAdminDataResponse liveGetChatAdminDataResponse = null;
        try {
            String channelId = super.createChannel();
            liveGetChatAdminDataRequest.setChannelId(channelId);
            liveGetChatAdminDataResponse = new LiveChatRoomServiceImpl().getChatAdminData(liveGetChatAdminDataRequest);
            Assert.assertNotNull(liveGetChatAdminDataResponse);
            if (liveGetChatAdminDataResponse != null) {
                //to do something ......
                log.debug("测试查询聊天室管理员信息成功{}", JSON.toJSONString(liveGetChatAdminDataResponse));
            }
        } 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、請求正確，回傳 LiveGetChatAdminDataResponse 物件，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/chat/get-banned-list

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetBannedList() throws Exception, NoSuchAlgorithmException {
        LiveGetBannedListRequest liveGetBannedListRequest = new LiveGetBannedListRequest();
        List<String> liveGetBannedListResponseList = null;
        try {
            String channelId = super.createChannel();
            liveGetBannedListRequest.setChannelId(channelId).setType(LiveConstant.BannedType.IP.getType());
            liveGetBannedListResponseList = new LiveChatRoomServiceImpl().getBannedList(liveGetBannedListRequest);
            Assert.assertNotNull(liveGetBannedListResponseList);
            if (liveGetBannedListResponseList != null) {
                //to do something ......
                log.debug("测试查询频道禁言列表成功{}", JSON.toJSONString(liveGetBannedListResponseList));
            }
        } 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、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

回傳物件描述

回傳物件是List<String>，String具體元素內容如下： 回傳當前頻道的禁言列表

5、查詢頻道踢人列表

描述

查询频道踢人列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/list-kicked

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetKickedList() throws Exception, NoSuchAlgorithmException {
        LiveKickedListRequest liveKickedListRequest = new LiveKickedListRequest();
        List<LiveKickedListResponse> liveKickedListResponsesList = null;
        try {
            String channelId = super.createChannel();
            liveKickedListRequest.setChannelId(channelId);
            liveKickedListResponsesList = new LiveChatRoomServiceImpl().getKickedList(liveKickedListRequest);
            Assert.assertNotNull(liveKickedListResponsesList);
            if (liveKickedListResponsesList != null) {
                //to do something ......
                log.debug("测试查询频道踢人列表成功{}", JSON.toJSONString(liveKickedListResponsesList));
            }
        } 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、請求正確，回傳 LiveKickedListResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求返回資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

回傳物件描述

回傳物件為 List<LiveKickedListResponse>，LiveKickedListResponse 具體元素內容如下：

6、查詢頻道嚴禁詞/禁言IP列表

描述

接口用于获取频道的严禁词或者禁言IP列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/badword/list

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChannelBadworkList() throws Exception, NoSuchAlgorithmException {
        LiveGetBadwordIPRequest liveGetBadwordIPRequest = new LiveGetBadwordIPRequest();
        List<String> liveGetBadwordIPResponseList = null;
        try {
            String channelId = super.createChannel();
            liveGetBadwordIPRequest.setChannelId(channelId).setType(LiveConstant.BannedType.IP.getType());
            liveGetBadwordIPResponseList = new LiveChatRoomServiceImpl().getChannelBadworkList(liveGetBadwordIPRequest);
            Assert.assertNotNull(liveGetBadwordIPResponseList);
            if (liveGetBadwordIPResponseList != null) {
                //to do something ......
                log.debug("测试查询频道严禁词/禁言IP列表成功{}", JSON.toJSONString(liveGetBadwordIPResponseList));
            }
        } 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、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請參閱 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求參數說明

回傳物件描述

回傳物件是List<String>，String具體元素內容如下： 取得當前頻道的禁止詞/禁言IP列表

7、查詢帳號禁止詞列表

描述

接口用于获取账号下通用设置的严禁词列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/user/badword/list

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetAccountBadworkList() throws Exception, NoSuchAlgorithmException {
        LiveGetAccountBadWordRequest liveGetAccountBadWordRequest = new LiveGetAccountBadWordRequest();
        List<String> liveGetAccountBadWordResponseList = null;
        try {
            liveGetAccountBadWordResponseList = new LiveChatRoomServiceImpl().getAccountBadworkList(
                    liveGetAccountBadWordRequest);
            Assert.assertNotNull(liveGetAccountBadWordResponseList);
            if (liveGetAccountBadWordResponseList != null) {
                //to do something ......
                log.debug("测试查询账号严禁词列表成功{}", JSON.toJSONString(liveGetAccountBadWordResponseList));
            }
        } 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、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因：invalid signature. ]

請求入參描述

返回物件描述

返回物件是List<String>，String具體元素內容如下： 當前保利威帳號下通用設定的禁止詞列表

8、查詢諮詢提問記錄

描述

查询咨询提问记录
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/chat/%s/getQuestion

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetConsultingRecord() throws Exception, NoSuchAlgorithmException {
        LiveGetConsultingRecordRequest liveGetConsultingRecordRequest = new LiveGetConsultingRecordRequest();
        List<LiveGetConsultingRecordResponse> liveGetConsultingRecordResponseList = null;
        try {
            String channelId = super.createChannel();
            liveGetConsultingRecordRequest.setChannelId(channelId).setBegin(0).setEnd(10);
            liveGetConsultingRecordResponseList = new LiveChatRoomServiceImpl().getConsultingRecord(
                    liveGetConsultingRecordRequest);
            Assert.assertNotNull(liveGetConsultingRecordResponseList);
            if (liveGetConsultingRecordResponseList != null) {
                //to do something ......
                log.debug("测试查询咨询提问记录成功{}", JSON.toJSONString(liveGetConsultingRecordResponseList));
            }
        } 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、請求正確，回傳 LiveGetConsultingRecordResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

回傳物件描述

回傳物件是List<LiveGetConsultingRecordResponse>，LiveGetConsultingRecordResponse具體元素內容如下：

User參數描述

9、設定講師資訊

描述

设置讲师信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/account/updateTeacher

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testSetChannelTeacherMsg() throws Exception, NoSuchAlgorithmException {
        LiveSetTeacherDataRequest liveSetTeacherDataRequest = new LiveSetTeacherDataRequest();
        Boolean liveSetTeacherDataResponse = null;
        try {
            String channelId = super.createChannel();
            liveSetTeacherDataRequest.setChannelId(channelId)
                    .setNickname("讲师张三")
                    .setActor("教授")
                    .setPasswd("123456")
                    .setAvatar("https://ss3.bdstatic.com/70cFv8Sh_Q1YnxGkpoWK1HF6hhy/it/u=3002379740," +
                            "3965499425&fm=26&gp=0" + ".jpg");
            liveSetTeacherDataResponse = new LiveChatRoomServiceImpl().setChannelTeacherMsg(liveSetTeacherDataRequest);
            Assert.assertNotNull(liveSetTeacherDataResponse);
            if (liveSetTeacherDataResponse != null) {
                //to do something ......
                log.debug("测试设置讲师信息成功{}", JSON.toJSONString(liveSetTeacherDataResponse));
            }
        } 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. ]

請求入參描述

回傳物件描述

true 設定講師資訊成功，false 設定講師資訊失敗

10、設定聊天室禁言IP

描述

设置聊天室禁言ip
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/chat/%s/addBannedIP

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testAddBannedIP() throws Exception, NoSuchAlgorithmException {
        LiveChatBannedIPRequest liveChatBannedIPRequest = new LiveChatBannedIPRequest();
        List<String> liveChatBannedIPResponseList = null;
        try {
            String channelId = super.createChannel();
            liveChatBannedIPRequest.setIp("192.168.1.1").setChannelId(channelId);
            liveChatBannedIPResponseList = new LiveChatRoomServiceImpl().addBannedIP(liveChatBannedIPRequest);
            Assert.assertNotNull(liveChatBannedIPResponseList);
            if (liveChatBannedIPResponseList != null) {
                //to do something ......
                log.debug("测试设置聊天室禁言ip成功{}", JSON.toJSONString(liveChatBannedIPResponseList));
            }
        } 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、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因：invalid signature. ]

請求入參說明

返回物件描述

回傳物件是 List<String>，String 具體元素內容如下： 目前所有的禁言 IP 列表

11、設定聊天室管理員資訊

描述

设置聊天室管理员信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/set-chat-admin

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testSetChatAdminData() throws Exception, NoSuchAlgorithmException, URISyntaxException {
        LiveSetChatAdminDataRequest liveSetChatAdminDataRequest = new LiveSetChatAdminDataRequest();
        Boolean liveSetChatAdminDataResponse = null;
        try {
            String channelId = super.createChannel();
            String path = getClass().getResource("/img/b.jpg").getPath();
            liveSetChatAdminDataRequest.setChannelId(channelId)
                    .setNickname("管理员赵四")
                    .setActor("管理员")
                    .setAvatar(new File(path));
            liveSetChatAdminDataResponse = new LiveChatRoomServiceImpl().setChatAdminData(liveSetChatAdminDataRequest);
            Assert.assertTrue(liveSetChatAdminDataResponse);
            if (liveSetChatAdminDataResponse != null) {
                //to do something ......
                log.debug("测试设置聊天室管理员信息成功{}", JSON.toJSONString(liveSetChatAdminDataResponse));
            }
        } 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. ]

請求入參說明

回傳物件描述

true 設定成功，false 設定失敗

12、刪除禁言IP/嚴禁詞

描述

删除禁言IP/严禁词
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/chat/%s/delBanned

調用約束

1、接口調用有頻率限制，詳細請查看，調用常見異常，詳細請查看

單元測試

    @Test
    public void testDelBanned() throws Exception, NoSuchAlgorithmException {
        LiveDelBannedDataRequest liveDelBannedDataRequest = new LiveDelBannedDataRequest();
        Boolean liveDelBannedDataResponse = null;
        try {
            //创建一个禁言IP（192.168.1.1）用于测试，实际业务过程中，此代码可以删除
            testAddBannedIP();
            //正式业务逻辑
            String channelId = super.createChannel();
            liveDelBannedDataRequest.setContent("192.168.1.1")
                    .setChannelId(channelId)
                    .setType(LiveConstant.BannedType.IP.getType());
            liveDelBannedDataResponse = new LiveChatRoomServiceImpl().delBanned(liveDelBannedDataRequest);
            Assert.assertNotNull(liveDelBannedDataResponse);
            if (liveDelBannedDataResponse != null) {
                //to do something ......
                log.debug("测试删除禁言IP/严禁词成功{}", JSON.toJSONString(liveDelBannedDataResponse));
            }
        } 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. ]

請求參數說明

回傳物件描述

true 刪除成功，false 刪除失敗

13、刪除單筆聊天記錄

描述

根据聊天的id删除对应聊天记录
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/send-admin-msg

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testDelChatSingleMsg() throws Exception, NoSuchAlgorithmException {
        LiveChatDelSingleMsgRequest liveChatDelSingleMsgRequest = new LiveChatDelSingleMsgRequest();
        Boolean liveChatDelSingleMsgResponse = null;
        String channelId = super.createChannel();
        //获取已经存在的消息id
        //new LiveChatRoomServiceImpl().sendChatMsg(liveSendChatMsgRequest)
        String msgId = getMsgId(channelId);
        try {
            liveChatDelSingleMsgRequest.setId(msgId).setChannelId(channelId);
            liveChatDelSingleMsgResponse = new LiveChatRoomServiceImpl().delChatSingleMsg(liveChatDelSingleMsgRequest);
            Assert.assertNotNull(liveChatDelSingleMsgResponse);
            if (liveChatDelSingleMsgResponse != null) {
                //to do something ......
                log.debug("测试删除单条聊天记录成功{}", JSON.toJSONString(liveChatDelSingleMsgResponse));
            }
        } 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. ]

請求入參描述

回傳物件描述

true 刪除成功，false 刪除失敗

14、刪除頻道聊天記錄

描述

删除频道聊天记录
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/chat/%s/cleanChat

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testCleanChannelAllMsg() throws Exception, NoSuchAlgorithmException {
        LiveCleanChannelAllMsgRequest liveCleanChannelAllMsgRequest = new LiveCleanChannelAllMsgRequest();
        Boolean liveCleanChannelAllMsgResponse = null;
        try {
            String channelId = super.createChannel();
            liveCleanChannelAllMsgRequest.setChannelId(channelId);
            liveCleanChannelAllMsgResponse = new LiveChatRoomServiceImpl().cleanChannelAllMsg(
                    liveCleanChannelAllMsgRequest);
            Assert.assertNotNull(liveCleanChannelAllMsgResponse);
            if (liveCleanChannelAllMsgResponse != null) {
                //to do something ......
                log.debug("测试删除频道聊天记录成功{}", JSON.toJSONString(liveCleanChannelAllMsgResponse));
            }
        } 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. ]

請求入參描述

回傳物件描述

true 刪除成功，false 刪除失敗

15、管理員發送頻道聊天訊息

描述

管理员发送频道聊天信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/send

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testSendChannelChat() throws Exception, NoSuchAlgorithmException {
        LiveSendChannelChatRequest liveSendChannelChatRequest = new LiveSendChannelChatRequest();
        Boolean liveSendChannelChatResponse;
        try {
            String channelId = super.createChannel();
            liveSendChannelChatRequest.setChannelId(channelId).setContent("请同学们认真学习").setRole("ADMIN");
            liveSendChannelChatResponse = new LiveChatRoomServiceImpl().sendChannelChat(liveSendChannelChatRequest);
            Assert.assertTrue(liveSendChannelChatResponse);
            if (liveSendChannelChatResponse) {
                //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. ]

請求參數說明

回傳物件描述

true 傳送成功，false 傳送失敗

16、發送自訂聊天訊息

描述

聊天室发送系统消息
接口地址（仅做说明使用）：https://api.polyv.net/live/v1/channelSetting/%s/send-chat

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testSendCustomChat() throws Exception, NoSuchAlgorithmException {
        LiveSendCustomChatRequest liveSendCustomChatRequest = new LiveSendCustomChatRequest();
        Boolean liveSendCustomChatResponse;
        try {
            String channelId = super.createChannel();
            liveSendCustomChatRequest.setChannelId(channelId).setContent("请同学们认真学习");
            liveSendCustomChatResponse = new LiveChatRoomServiceImpl().sendCustomChatV2(liveSendCustomChatRequest);
            Assert.assertTrue(liveSendCustomChatResponse);
            if (liveSendCustomChatResponse) {
                //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. ]

請求入參說明

回傳物件描述

true 發送成功，false 發送失敗

17、傳送自訂訊息

描述

发送聊天室自定义消息
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/chat/send-custom-message

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

2、需要發送的文字內容（content）或圖片（imgUrl）不能同時為空，可以同時提交

單元測試

    @Test
    public void testSendCustomMessage() throws IOException, NoSuchAlgorithmException {
        LiveSendCustomMessageRequest liveSendCustomMessageRequest = new LiveSendCustomMessageRequest();
        Boolean liveSendCustomMessageResponse;
        try {
            String channelId = super.createChannel();
            liveSendCustomMessageRequest.setChannelId(channelId).setContent("请同学们认真学习，天天向上！").setJoinHistoryList(0);
            liveSendCustomMessageResponse = new LiveChatRoomServiceImpl().sendCustomMessage(
                    liveSendCustomMessageRequest);
            Assert.assertTrue(liveSendCustomMessageResponse);
            if (liveSendCustomMessageResponse) {
                //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. ]

請求入參說明

回傳物件描述

發送自訂訊息回傳實體

18、刪除帳號禁止詞

描述

删除账号通用设置的严禁词，支持批量删除多个严禁词
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/user/badword/delete

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testDeleteUserBadword() throws IOException, NoSuchAlgorithmException {
        LiveDeleteUserBadwordRequest liveDeleteUserBadwordRequest = new LiveDeleteUserBadwordRequest();
        List<String> liveDeleteUserBadwordResponse;
        try {
            String words = "中南";
            liveDeleteUserBadwordRequest.setWords(words);
            liveDeleteUserBadwordResponse = new LiveChatRoomServiceImpl().deleteUserBadword(
                    liveDeleteUserBadwordRequest);
            Assert.assertNotNull(liveDeleteUserBadwordResponse);
            if (liveDeleteUserBadwordResponse != null) {
                //to do something ......
                log.debug("测试删除账号严禁词成功 {}", JSON.toJSONString(liveDeleteUserBadwordResponse));
            }
        } 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、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

回傳物件描述

回傳物件是List<String>，String具體元素內容如下： 刪除帳號嚴禁詞回傳實體

19、查詢帳號禁言列表

描述

通过账号下的禁言列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/user/chat/banned-user/list

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetUserBannedList() throws IOException, NoSuchAlgorithmException {
        LiveGetUserBannedListRequest liveGetUserBannedListRequest = new LiveGetUserBannedListRequest();
        LiveGetUserBannedListResponse liveGetUserBannedListResponse;
        try {
            liveGetUserBannedListRequest.setCurrentPage(1);
            liveGetUserBannedListRequest.setPageSize(10);
            liveGetUserBannedListResponse = new LiveChatRoomServiceImpl().getUserBannedList(
                    liveGetUserBannedListRequest);
            Assert.assertNotNull(liveGetUserBannedListResponse);
            if (liveGetUserBannedListResponse != null) {
                //to do something ......
                log.debug("测试查询账号禁言列表成功 {}", JSON.toJSONString(liveGetUserBannedListResponse));
            }
        } 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、請求正確，回傳 LiveGetUserBannedListResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請參閱 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

回傳物件描述

20、禁言/解除禁言使用者

描述

通过登录聊天室的userId，禁言或者解禁用户
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/banned-user

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateBannedUser() throws IOException, NoSuchAlgorithmException {
        LiveUpdateBannedUserRequest liveUpdateBannedUserRequest = new LiveUpdateBannedUserRequest();
        Boolean liveUpdateBannedUserResponse;
        try {
            String channelId = super.createChannel();
            liveUpdateBannedUserRequest.setChannelId(channelId);
            liveUpdateBannedUserRequest.setUserIds("ovtl9t_RxnrTdqkXqkT5Q5lnxp2A");
            liveUpdateBannedUserResponse = new LiveChatRoomServiceImpl().updateBannedUser(liveUpdateBannedUserRequest);
            Assert.assertNotNull(liveUpdateBannedUserResponse);
            if (liveUpdateBannedUserResponse != null) {
                //to do something ......
                log.debug("测试禁言/解禁用户成功 {}", JSON.toJSONString(liveUpdateBannedUserResponse));
            }
        } 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. ]

請求入參說明

回傳物件描述

禁言/解除禁言用戶回傳實體

21、帳號設定禁言/解禁用戶

描述

通过登录聊天室的userId，禁言或者解禁用户
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/user/chat/banned-user/update

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateUserBannedViewer() throws IOException, NoSuchAlgorithmException {
        LiveUpdateUserBannedViewerRequest liveUpdateUserBannedViewerRequest = new LiveUpdateUserBannedViewerRequest();
        Boolean liveUpdateUserBannedViewerResponse;
        try {
            List<String> viewerIds = new ArrayList<>();
            viewerIds.add("test");
            liveUpdateUserBannedViewerRequest.setViewerIds(viewerIds);
            liveUpdateUserBannedViewerRequest.setBanned("Y");
            liveUpdateUserBannedViewerResponse = new LiveChatRoomServiceImpl().updateUserBannedViewer(
                    liveUpdateUserBannedViewerRequest);
            Assert.assertNotNull(liveUpdateUserBannedViewerResponse);
            if (liveUpdateUserBannedViewerResponse != null) {
                //to do something ......
                log.debug("测试账号设置禁言/解禁用户成功 {}", JSON.toJSONString(liveUpdateUserBannedViewerResponse));
            }
        } 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. ]

請求入參說明

回傳物件描述

帳號設定禁言/解禁使用者回傳實體

22、管理員發送聊天訊息

描述

通过HTTP接口发送聊天文本内容，可指定发言者的头像、头衔、昵称，无需连接聊天室
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/send-admin-msg

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testSendAdminMessage() throws IOException, NoSuchAlgorithmException {
        LiveSendAdminMessageRequest liveSendAdminMessageRequest = new LiveSendAdminMessageRequest();
        LiveSendAdminMessageResponse liveSendAdminMessageResponse;
        try {
            String channelId = super.createChannel();
            liveSendAdminMessageRequest.setChannelId(channelId)
                    .setMsg("hello 大家好-通过API发过来的测试信息")
                    .setPic("https://5b0988e595225.cdn.sohucs.com/q_70,c_zoom," +
                            "w_640/images/20190129/e3b0d6311b1a411fa68125fc03b8ef67.jpeg")
                    .setNickName("thomas")
                    .setImgUrl("https://5b0988e595225.cdn.sohucs.com/q_70,c_zoom," +
                            "w_640/images/20190129/e3b0d6311b1a411fa68125fc03b8ef67.jpeg")
                    .setFreeReview(LiveConstant.Flag.YES.getFlag());
            liveSendAdminMessageResponse = new LiveChatRoomServiceImpl().sendAdminMessage(liveSendAdminMessageRequest);
            Assert.assertNotNull(liveSendAdminMessageResponse);
            if (liveSendAdminMessageResponse != null) {
                //to do something ......
                log.debug("测试管理员发送聊天信息成功 {}", JSON.toJSONString(liveSendAdminMessageResponse));
            }
        } 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、請求正確，回傳 LiveSendAdminMessageResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求參數說明

回傳物件描述

23、更新聊天審核開關

描述

更新聊天审核开关
接口地址（仅做说明使用）：https://api.polyv.net/live/v3/channel/chat/update-censor-enabled

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChatCensorEnabled() throws IOException, NoSuchAlgorithmException {
        LiveUpdateChatCensorRequest liveUpdateChatCensorRequest = new LiveUpdateChatCensorRequest();
        Boolean liveUpdateChatCensorResponse;
        try {
            String channelId = super.createChannel();
            liveUpdateChatCensorRequest.setChannelId(channelId);
            liveUpdateChatCensorResponse = new LiveChatRoomServiceImpl().updateChatCensorEnabled(
                    liveUpdateChatCensorRequest);
            Assert.assertNotNull(liveUpdateChatCensorResponse);
            if (liveUpdateChatCensorResponse != null) {
                //to do something ......
                log.debug("测试更新聊天审核开关成功，当前状态 {}", liveUpdateChatCensorResponse);
            }
        } 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. ]

請求入參說明

回傳物件描述

設定成功返回當前聊天審核開關類型，開啟為 true，未開啟為 false

24、傳送開播端彈窗訊息

描述

用于直播中，给开播讲师以弹窗形式发送特定消息的能力（当前仅支持给讲师触发）
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/chat/alert-to-special

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testAlertChatSpecial() throws IOException, NoSuchAlgorithmException {
        LiveAlertChatSpecialRequest liveAlertChatSpecialRequest = new LiveAlertChatSpecialRequest();
        Boolean liveAlertChatSpecialResponse;
        try {
            String channelId = super.createChannel();
            liveAlertChatSpecialRequest.setChannelId(channelId).setTitle("测试弹窗").setMessage("弹窗内容为hello world");
            liveAlertChatSpecialResponse = new LiveChatRoomServiceImpl().alertChatSpecial(liveAlertChatSpecialRequest);
            Assert.assertNotNull(liveAlertChatSpecialResponse);
            if (liveAlertChatSpecialResponse != null) {
                //to do something ......
                log.debug("测试发送开播端弹窗消息成功 {}", liveAlertChatSpecialRequest);
            }
        } 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. ]

請求入參說明

回傳物件描述

true 表示呼叫成功，false 表示呼叫失敗

25、發布公告

描述

发布频道公告，支持置顶和弹窗
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/chat/add-bullentin

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testAddBullentin() throws IOException, NoSuchAlgorithmException {
        LiveAddBullentinRequest liveAddBullentinRequest = new LiveAddBullentinRequest();
        Boolean liveAddBullentinResponse;
        try {
            String channelId = super.createChannel();
            liveAddBullentinRequest.setChannelId(channelId)
                    .setContent("测试发布公告")
                    .setIsTop(LiveConstant.Flag.YES.getFlag())
                    .setIsPop(LiveConstant.Flag.YES.getFlag());

            liveAddBullentinResponse = new LiveChatRoomServiceImpl().addBullentin(liveAddBullentinRequest);
            Assert.assertNotNull(liveAddBullentinResponse);
            if (liveAddBullentinResponse != null) {
                //to do something ......
                log.debug("测试发布公告成功 {}", liveAddBullentinResponse);
            }
        } 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. ]

請求入參說明

回傳物件描述

true 表示呼叫成功，false 表示呼叫失敗

26、查詢頻道公告列表

描述

分页查询频道公告列表
接口地址（仅做说明使用）：https://api.polyv.net/live/v4/chat/list-bullentin

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testListBullentin() throws IOException, NoSuchAlgorithmException {
        LiveListBullentinRequest liveListBullentinRequest = new LiveListBullentinRequest();
        LiveListBullentinResponse liveListBullentinResponse;
        try {
            String channelId = super.createChannel();
            liveListBullentinRequest.setChannelId(channelId)
                    .setPageNumber(1)
                    .setPageSize(10);

            liveListBullentinResponse = new LiveChatRoomServiceImpl().listBullentin(liveListBullentinRequest);
            Assert.assertNotNull(liveListBullentinResponse);
            if (liveListBullentinResponse != null) {
                //to do something ......
                log.debug("测试查询公告列表成功 {}", JSON.toJSONString(liveListBullentinResponse));
            }
        } 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. 請求正確，回傳 LiveListBullentinResponse 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤訊息請見 PloyvSdkException.getMessage()，例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊請見 PloyvSdkException.getMessage()，例如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參說明

回傳物件描述

Bullentin參數描述