Package com.foxinmy.weixin4j.qy.api

Class ChatApi

  • public class ChatApi
extends QyApi
    会话服务接口
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)
    See Also:
    企业号消息服务

    • Constructor Detail

      • ChatApi

        public ChatApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • createChat

        public String createChat​(ChatInfo chatInfo)
                  throws com.foxinmy.weixin4j.exception.WeixinException
        创建会话 如果会话id为空,程序会自动生成一个唯一ID
        Parameters:
        chatInfo - 会话信息
        Returns:
        会话ID
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        ChatInfo, 创建会话

      • getChat

        public ChatInfo getChat​(String chatId)
                 throws com.foxinmy.weixin4j.exception.WeixinException
        获取会话
        Parameters:
        chatId - 会话ID
        Returns:
        会话信息
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        ChatInfo, 获取会话

      • updateChat

        public com.foxinmy.weixin4j.http.weixin.ApiResult updateChat​(ChatInfo chatInfo,
                                                             String operator,
                                                             List<String> addUsers,
                                                             List<String> deleteUsers)
                                                      throws com.foxinmy.weixin4j.exception.WeixinException
        更新会话
        Parameters:
        chatInfo - 会话信息 至少保持会话ID不能为空
        operator - 操作人userid
        addUsers - 会话新增成员列表
        deleteUsers - 会话退出成员列表
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        ChatInfo, 修改会话信息

      • quitChat

        public com.foxinmy.weixin4j.http.weixin.ApiResult quitChat​(String chatId,
                                                           String operator)
                                                    throws com.foxinmy.weixin4j.exception.WeixinException
        退出会话
        Parameters:
        chatId - 会话ID
        operator - 操作人userid
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        退出会话

      • clearChatNotify

        public com.foxinmy.weixin4j.http.weixin.ApiResult clearChatNotify​(String targetId,
                                                                  String owner,
                                                                  ChatType chatType)
                                                           throws com.foxinmy.weixin4j.exception.WeixinException
        清除会话未读状态
        Parameters:
        targetId - 会话值，为userid|chatid，分别表示：成员id|会话id
        owner - 会话所有者的userid
        chatType - 会话类型：single|group，分别表示：群聊|单聊
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        清除会话未读状态

      • setChatMute

        public List<String> setChatMute​(List<ChatMute> chatMutes)
                         throws com.foxinmy.weixin4j.exception.WeixinException
        设置成员接收到的消息是否提醒。主要场景是用于对接企业im的在线状态，如成员处于在线状态时，可以设置该成员的消息免打扰。当成员离线时，关闭免打扰状态 ，对微信端进行提醒。
        Parameters:
        chatMutes - 提醒参数
        Returns:
        列表中不存在的成员，剩余合法成员会继续执行。
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        ChatMute, 设置成员新消息免打扰

      • sendChatMessage

        public com.foxinmy.weixin4j.http.weixin.ApiResult sendChatMessage​(ChatMessage message)
                                                           throws com.foxinmy.weixin4j.exception.WeixinException
        发送消息
        Parameters:
        message - 消息对象
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        ChatMessage, 发送消息