net.polyv.live.v1.service.chat

接口 ILiveChatRoomService

所有已知实现类:

LiveChatRoomServiceImpl

public interface ILiveChatRoomService

直播签到管理

方法概要

限定符和类型	方法和说明
LiveBadWordResponse	addBadWord(LiveBadWordRequest liveBadWordRequest) 批量导入频道严禁词，API地址：https://dev.polyv.net/2017/liveproduct/zblts/addforbiddenwords/
List<String>	addBannedIP(LiveChatBannedIPRequest liveChatBannedIPRequest) 设置聊天室禁言ip，API地址：https://dev.polyv.net/2017/liveproduct/zblts/addbannedip/
Boolean	alertChatSpecial(LiveAlertChatSpecialRequest liveAlertChatSpecialRequest) 发送开播端弹窗消息 API地址：https://help.polyv.net/index.html#/live/api/chat/message/chat_alert_to_special
Boolean	cleanChannelAllMsg(LiveCleanChannelAllMsgRequest liveCleanChannelAllMsgRequest) 删除频道聊天记录，API地址：https://dev.polyv.net/2017/liveproduct/zblts/cleanchat/
Boolean	delBanned(LiveDelBannedDataRequest liveDelBannedDataRequest) 删除禁言IP/严禁词，API地址：https://dev.polyv.net/2017/liveproduct/zblts/delbanned/
Boolean	delChatSingleMsg(LiveChatDelSingleMsgRequest liveChatDelSingleMsgRequest) 删除单条聊天记录，API地址：https://dev.polyv.net/2017/liveproduct/zblts/delchat/
List<String>	deleteUserBadword(LiveDeleteUserBadwordRequest liveDeleteUserBadwordRequest) 删除账号严禁词 API地址：https://help.polyv.net/#/live/api/chat/banned/delete_user_badword
List<String>	getAccountBadworkList(LiveGetAccountBadWordRequest liveGetAccountBadWordRequest) 查询账号严禁词列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/user-badword-list/
List<String>	getBannedList(LiveGetBannedListRequest liveGetBannedListRequest) 查询频道禁言列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/get-banned-list/
List<String>	getChannelBadworkList(LiveGetBadwordIPRequest liveGetBadwordIPRequest) 查询频道严禁词/禁言IP列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/get-channel-badwords/
LiveGetChatAdminDataResponse	getChatAdminData(LiveGetChatAdminDataRequest liveGetChatAdminDataRequest) 查询聊天室管理员信息，API地址：https://dev.polyv.net/2017/liveproduct/zblts/get-chat-admin/
Integer	getChatUserCount(LiveGetChatUserCountRequest liveGetChatUserCountRequest) 获取聊天室在线人数 API地址：https://help.polyv.net/index.html#/live/api/channel/operate/get_chat_online_count
List<LiveGetConsultingRecordResponse>	getConsultingRecord(LiveGetConsultingRecordRequest liveGetConsultingRecordRequest) 查询咨询提问记录，API地址：https://dev.polyv.net/2018/liveproduct/zblts/getquestion/
List<LiveGetHistoryChatMsgResponse>	getHistoryChatMsg(LiveGetHistoryChatMsgRequest liveGetHistoryChatMsgRequest) 查询历史聊天信息，API地址：https://dev.polyv.net/2019/liveproduct/zblts/get-channel-badwords/
List<LiveKickedListResponse>	getKickedList(LiveKickedListRequest liveKickedListRequest) 查询频道踢人列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/list-kicked/
LiveGetMessageListResponse	getPageHistoryChatMsg(LiveGetMessageListRequest liveGetMessageListRequest) 查询历史聊天信息，API地址：https://help.polyv.net/index.html#/live/api/chat/message/get_message_list
List<LiveGetQuestionStatisticalResponse>	getQuestionStatistical(LiveGetQuestionStatisticalRequest liveGetQuestionStatisticalRequest) 查询频道的问答统计结果，API地址：https://dev.polyv.net/2018/liveproduct/zblts/get-question-result/
LiveGetRobotSettingResponse	getRobotSetting(LiveGetRobotSettingRequest liveGetRobotSettingRequest) 查询频道虚拟人数设置 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/get_robot_setting
LiveGetRobotStatsResponse	getRobotStats(LiveGetRobotStatsRequest liveGetRobotStatsRequest) 查询频道虚拟人数详情 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/get_robot_stats
LiveGetUserBannedListResponse	getUserBannedList(LiveGetUserBannedListRequest liveGetUserBannedListRequest) 查询账号禁言列表 API地址：https://help.polyv.net/#/live/api/chat/banned/get_user_banned_list
Boolean	pauseRobot(LivePauseRobotRequest livePauseRobotRequest) 停止频道虚拟人数 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/pause_robot
LiveSendAdminMessageResponse	sendAdminMessage(LiveSendAdminMessageRequest liveSendAdminMessageRequest) 管理员发送聊天信息 API地址：https://help.polyv.net/index.html#/live/api/chat/message/send_message
Boolean	sendChannelChat(LiveSendChannelChatRequest liveSendChannelChatRequest) 管理员发送频道聊天信息 API地址：https://dev.polyv.net/2018/liveproduct/zblts/chatsendmsg/
LiveSendChatMsgResponse	sendChatMsg(LiveSendChatMsgRequest liveSendChatMsgRequest) 通过HTTP接口发送聊天消息请求实体，API地址：https://dev.polyv.net/2019/liveproduct/zblts/send-admin-msg/
Boolean	sendCustomChat(LiveSendCustomChatRequest liveSendCustomChatRequest) 已过时。
Boolean	sendCustomChatV2(LiveSendCustomChatRequest liveSendCustomChatRequest) 发送自定义聊天信息 兼容性升级V2修复bug API地址：https://dev.polyv.net/2016/liveproduct/zblts/send-chat/
Boolean	sendCustomMessage(LiveSendCustomMessageRequest liveSendCustomMessageRequest) 发送自定义消息，支持是否加入到聊天消息记录 API地址：https://help.polyv.net/#/live/api/v4/chat/send_custom_message
Boolean	setChannelTeacherMsg(LiveSetTeacherDataRequest liveSetTeacherDataRequest) 设置讲师信息，API地址：https://dev.polyv.net/2019/liveproduct/zblts/update-channel-teacher/
Boolean	setChatAdminData(LiveSetChatAdminDataRequest liveSetChatAdminDataRequest) 设置聊天室管理员信息，API地址：https://dev.polyv.net/2017/liveproduct/zblts/set-chat-admin/
Boolean	updateBannedUser(LiveUpdateBannedUserRequest liveUpdateBannedUserRequest) 禁言/解禁用户 API地址：https://help.polyv.net/#/live/api/chat/banned/update_banned_user
Boolean	updateChatCensorEnabled(LiveUpdateChatCensorRequest liveUpdateChatCensorRequest) 更新聊天审核开关 API地址：https://help.polyv.net/#/live/api/chat/censor/update_censor_enabled
Boolean	updateRobotSetting(LiveUpdateRobotSettingRequest liveUpdateRobotSettingRequest) 设置频道虚拟人数 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/update_robot_setting
Boolean	updateUserBannedViewer(LiveUpdateUserBannedViewerRequest liveUpdateUserBannedViewerRequest) 账号设置禁言/解禁用户 API地址：https://help.polyv.net/#/live/api/chat/banned/update_user_banned_viewer

方法详细资料

sendChatMsg

LiveSendChatMsgResponse sendChatMsg(LiveSendChatMsgRequest liveSendChatMsgRequest)
                             throws IOException,
                                    NoSuchAlgorithmException

通过HTTP接口发送聊天消息请求实体，API地址：https://dev.polyv.net/2019/liveproduct/zblts/send-admin-msg/

参数:

liveSendChatMsgRequest - 查询签到结果请求实体

返回:

响应实体

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

setChannelTeacherMsg

Boolean setChannelTeacherMsg(LiveSetTeacherDataRequest liveSetTeacherDataRequest)
                      throws IOException,
                             NoSuchAlgorithmException

设置讲师信息，API地址：https://dev.polyv.net/2019/liveproduct/zblts/update-channel-teacher/

参数:

liveSetTeacherDataRequest - 设置讲师信息请求实体

返回:

响应实体

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

addBannedIP

List<String> addBannedIP(LiveChatBannedIPRequest liveChatBannedIPRequest)
                  throws IOException,
                         NoSuchAlgorithmException

设置聊天室禁言ip，API地址：https://dev.polyv.net/2017/liveproduct/zblts/addbannedip/

参数:

liveChatBannedIPRequest - 设置聊天室禁言ip请求实体

返回:

当前账号下所有禁言IP列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

addBadWord

LiveBadWordResponse addBadWord(LiveBadWordRequest liveBadWordRequest)
                        throws IOException,
                               NoSuchAlgorithmException

批量导入频道严禁词，API地址：https://dev.polyv.net/2017/liveproduct/zblts/addforbiddenwords/

参数:

liveBadWordRequest - 批量导入频道严禁词请求实体

返回:

响应实体

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

getBannedList

List<String> getBannedList(LiveGetBannedListRequest liveGetBannedListRequest)
                    throws IOException,
                           NoSuchAlgorithmException

查询频道禁言列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/get-banned-list/

参数:

liveGetBannedListRequest - 查询频道禁言列表请求实体

返回:

当前账号下所有禁言IP列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

getKickedList

List<LiveKickedListResponse> getKickedList(LiveKickedListRequest liveKickedListRequest)
                                    throws IOException,
                                           NoSuchAlgorithmException

查询频道踢人列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/list-kicked/

参数:

liveKickedListRequest - 查询频道踢人列表请求实体

返回:

当前账号下所有禁言IP列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

delBanned

Boolean delBanned(LiveDelBannedDataRequest liveDelBannedDataRequest)
           throws IOException,
                  NoSuchAlgorithmException

删除禁言IP/严禁词，API地址：https://dev.polyv.net/2017/liveproduct/zblts/delbanned/

参数:

liveDelBannedDataRequest - 删除禁言IP/严禁词请求实体

返回:

当前账号下所有禁言IP列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

getChannelBadworkList

List<String> getChannelBadworkList(LiveGetBadwordIPRequest liveGetBadwordIPRequest)
                            throws IOException,
                                   NoSuchAlgorithmException

查询频道严禁词/禁言IP列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/get-channel-badwords/

参数:

liveGetBadwordIPRequest - 查询频道严禁词/禁言IP列表请求实体

返回:

禁言IP 或者 禁言词

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

getAccountBadworkList

List<String> getAccountBadworkList(LiveGetAccountBadWordRequest liveGetAccountBadWordRequest)
                            throws IOException,
                                   NoSuchAlgorithmException

查询账号严禁词列表，API地址：https://dev.polyv.net/2019/liveproduct/zblts/user-badword-list/

参数:

liveGetAccountBadWordRequest - 查询账号严禁词列表请求实体

返回:

禁言词列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

cleanChannelAllMsg

Boolean cleanChannelAllMsg(LiveCleanChannelAllMsgRequest liveCleanChannelAllMsgRequest)
                    throws IOException,
                           NoSuchAlgorithmException

删除频道聊天记录，API地址：https://dev.polyv.net/2017/liveproduct/zblts/cleanchat/

参数:

liveCleanChannelAllMsgRequest - 删除频道聊天记录请求实体

返回:

频道号

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 签名异常

getChatAdminData

LiveGetChatAdminDataResponse getChatAdminData(LiveGetChatAdminDataRequest liveGetChatAdminDataRequest)
                                       throws IOException,
                                              NoSuchAlgorithmException

查询聊天室管理员信息，API地址：https://dev.polyv.net/2017/liveproduct/zblts/get-chat-admin/

参数:

liveGetChatAdminDataRequest - 查询聊天室管理员信息请求实体

返回:

频道号

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 签名异常

getHistoryChatMsg

List<LiveGetHistoryChatMsgResponse> getHistoryChatMsg(LiveGetHistoryChatMsgRequest liveGetHistoryChatMsgRequest)
                                               throws IOException,
                                                      NoSuchAlgorithmException

查询历史聊天信息，API地址：https://dev.polyv.net/2019/liveproduct/zblts/get-channel-badwords/

参数:

liveGetHistoryChatMsgRequest - 查询历史聊天信息请求实体

返回:

想要实体列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

getPageHistoryChatMsg

LiveGetMessageListResponse getPageHistoryChatMsg(LiveGetMessageListRequest liveGetMessageListRequest)
                                          throws IOException,
                                                 NoSuchAlgorithmException

查询历史聊天信息，API地址：https://help.polyv.net/index.html#/live/api/chat/message/get_message_list

参数:

liveGetMessageListRequest - 查询历史聊天信息请求实体

返回:

想要实体列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

delChatSingleMsg

Boolean delChatSingleMsg(LiveChatDelSingleMsgRequest liveChatDelSingleMsgRequest)
                  throws IOException,
                         NoSuchAlgorithmException

删除单条聊天记录，API地址：https://dev.polyv.net/2017/liveproduct/zblts/delchat/

参数:

liveChatDelSingleMsgRequest - 删除单条聊天记录请求实体

返回:

是否成功

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 签名异常

setChatAdminData

Boolean setChatAdminData(LiveSetChatAdminDataRequest liveSetChatAdminDataRequest)
                  throws IOException,
                         NoSuchAlgorithmException

设置聊天室管理员信息，API地址：https://dev.polyv.net/2017/liveproduct/zblts/set-chat-admin/

参数:

liveSetChatAdminDataRequest - 设置聊天室管理员信息请求实体

返回:

是否成功

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 签名异常

getConsultingRecord

List<LiveGetConsultingRecordResponse> getConsultingRecord(LiveGetConsultingRecordRequest liveGetConsultingRecordRequest)
                                                   throws IOException,
                                                          NoSuchAlgorithmException

查询咨询提问记录，API地址：https://dev.polyv.net/2018/liveproduct/zblts/getquestion/

参数:

liveGetConsultingRecordRequest - 查询咨询提问记录请求实体

返回:

实体列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

getQuestionStatistical

List<LiveGetQuestionStatisticalResponse> getQuestionStatistical(LiveGetQuestionStatisticalRequest liveGetQuestionStatisticalRequest)
                                                         throws IOException,
                                                                NoSuchAlgorithmException

查询频道的问答统计结果，API地址：https://dev.polyv.net/2018/liveproduct/zblts/get-question-result/

参数:

liveGetQuestionStatisticalRequest - 查询频道的问答统计结果请求实体

返回:

想要实体列表

抛出:

IOException - 客户端和服务器读写异常

NoSuchAlgorithmException - 异常

sendChannelChat

Boolean sendChannelChat(LiveSendChannelChatRequest liveSendChannelChatRequest)
                 throws IOException,
                        NoSuchAlgorithmException

管理员发送频道聊天信息 API地址：https://dev.polyv.net/2018/liveproduct/zblts/chatsendmsg/

参数:

liveSendChannelChatRequest - 管理员发送频道聊天信息请求实体

返回:

管理员发送频道聊天信息返回实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

sendCustomChat

@Deprecated
Boolean sendCustomChat(LiveSendCustomChatRequest liveSendCustomChatRequest)
                             throws IOException,
                                    NoSuchAlgorithmException

已过时。

发送自定义聊天信息 API地址：https://dev.polyv.net/2016/liveproduct/zblts/send-chat/

参数:

liveSendCustomChatRequest - 发送自定义聊天信息请求实体

返回:

发送自定义聊天信息返回实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

sendCustomChatV2

Boolean sendCustomChatV2(LiveSendCustomChatRequest liveSendCustomChatRequest)
                  throws IOException,
                         NoSuchAlgorithmException

发送自定义聊天信息 兼容性升级V2修复bug API地址：https://dev.polyv.net/2016/liveproduct/zblts/send-chat/

参数:

liveSendCustomChatRequest - 发送自定义聊天信息请求实体

返回:

发送自定义聊天信息返回实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

sendCustomMessage

Boolean sendCustomMessage(LiveSendCustomMessageRequest liveSendCustomMessageRequest)
                   throws IOException,
                          NoSuchAlgorithmException

发送自定义消息，支持是否加入到聊天消息记录 API地址：https://help.polyv.net/#/live/api/v4/chat/send_custom_message

参数:

liveSendCustomMessageRequest - 发送自定义消息请求实体

返回:

发送自定义消息响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

getRobotSetting

LiveGetRobotSettingResponse getRobotSetting(LiveGetRobotSettingRequest liveGetRobotSettingRequest)
                                     throws IOException,
                                            NoSuchAlgorithmException

查询频道虚拟人数设置 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/get_robot_setting

参数:

liveGetRobotSettingRequest - 查询频道虚拟人数设置请求实体

返回:

查询频道虚拟人数设置响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

getRobotStats

LiveGetRobotStatsResponse getRobotStats(LiveGetRobotStatsRequest liveGetRobotStatsRequest)
                                 throws IOException,
                                        NoSuchAlgorithmException

查询频道虚拟人数详情 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/get_robot_stats

参数:

liveGetRobotStatsRequest - 查询频道虚拟人数详情请求实体

返回:

查询频道虚拟人数详情响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

updateRobotSetting

Boolean updateRobotSetting(LiveUpdateRobotSettingRequest liveUpdateRobotSettingRequest)
                    throws IOException,
                           NoSuchAlgorithmException

设置频道虚拟人数 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/update_robot_setting

参数:

liveUpdateRobotSettingRequest - 设置频道虚拟人数请求实体

返回:

设置频道虚拟人数响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

pauseRobot

Boolean pauseRobot(LivePauseRobotRequest livePauseRobotRequest)
            throws IOException,
                   NoSuchAlgorithmException

停止频道虚拟人数 API地址：https://help.polyv.net/#/live/api/v4/chat/robot/pause_robot

参数:

livePauseRobotRequest - 停止频道虚拟人数请求实体

返回:

停止频道虚拟人数响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

deleteUserBadword

List<String> deleteUserBadword(LiveDeleteUserBadwordRequest liveDeleteUserBadwordRequest)
                        throws IOException,
                               NoSuchAlgorithmException

删除账号严禁词 API地址：https://help.polyv.net/#/live/api/chat/banned/delete_user_badword

参数:

liveDeleteUserBadwordRequest - 删除账号严禁词请求实体

返回:

删除账号严禁词响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

getUserBannedList

LiveGetUserBannedListResponse getUserBannedList(LiveGetUserBannedListRequest liveGetUserBannedListRequest)
                                         throws IOException,
                                                NoSuchAlgorithmException

查询账号禁言列表 API地址：https://help.polyv.net/#/live/api/chat/banned/get_user_banned_list

参数:

liveGetUserBannedListRequest - 查询账号禁言列表请求实体

返回:

查询账号禁言列表响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

updateBannedUser

Boolean updateBannedUser(LiveUpdateBannedUserRequest liveUpdateBannedUserRequest)
                  throws IOException,
                         NoSuchAlgorithmException

禁言/解禁用户 API地址：https://help.polyv.net/#/live/api/chat/banned/update_banned_user

参数:

liveUpdateBannedUserRequest - 禁言/解禁用户请求实体

返回:

禁言/解禁用户响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

updateUserBannedViewer

Boolean updateUserBannedViewer(LiveUpdateUserBannedViewerRequest liveUpdateUserBannedViewerRequest)
                        throws IOException,
                               NoSuchAlgorithmException

账号设置禁言/解禁用户 API地址：https://help.polyv.net/#/live/api/chat/banned/update_user_banned_viewer

参数:

liveUpdateUserBannedViewerRequest - 账号设置禁言/解禁用户请求实体

返回:

账号设置禁言/解禁用户响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

sendAdminMessage

LiveSendAdminMessageResponse sendAdminMessage(LiveSendAdminMessageRequest liveSendAdminMessageRequest)
                                       throws IOException,
                                              NoSuchAlgorithmException

管理员发送聊天信息 API地址：https://help.polyv.net/index.html#/live/api/chat/message/send_message

参数:

liveSendAdminMessageRequest - 管理员发送聊天信息请求实体

返回:

管理员发送聊天信息响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

getChatUserCount

Integer getChatUserCount(LiveGetChatUserCountRequest liveGetChatUserCountRequest)
                  throws IOException,
                         NoSuchAlgorithmException

获取聊天室在线人数 API地址：https://help.polyv.net/index.html#/live/api/channel/operate/get_chat_online_count

参数:

liveGetChatUserCountRequest - 获取聊天室在线人数请求实体

返回:

获取聊天室在线人数响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

updateChatCensorEnabled

Boolean updateChatCensorEnabled(LiveUpdateChatCensorRequest liveUpdateChatCensorRequest)
                         throws IOException,
                                NoSuchAlgorithmException

更新聊天审核开关 API地址：https://help.polyv.net/#/live/api/chat/censor/update_censor_enabled

参数:

liveUpdateChatCensorRequest - 更新聊天审核开关请求实体

返回:

获取聊天室在线人数响应实体响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常

alertChatSpecial

Boolean alertChatSpecial(LiveAlertChatSpecialRequest liveAlertChatSpecialRequest)
                  throws IOException,
                         NoSuchAlgorithmException

发送开播端弹窗消息 API地址：https://help.polyv.net/index.html#/live/api/chat/message/chat_alert_to_special

参数:

liveAlertChatSpecialRequest - 发送开播端弹窗消息请求实体

返回:

发送开播端弹窗消息响应实体

抛出:

IOException - 异常

NoSuchAlgorithmException - 异常