收发消息

功能简介

ZIM SDK 支持单聊消息、群组消息、房间消息等的收发，以及查询历史消息、删除消息等功能。可广泛应用于娱乐社交、电商购物、在线教育、互动直播等多种场景下。

本文档介绍了如何使用 ZIM SDK 的接口，实现各类消息的收发功能与监听消息的状态。

消息类型

目前 ZIM 支持的消息类型如下：

前提条件

在实现“收发消息”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

收发普通消息

普通消息，包含 ZIMTextMessage、ZIMBarrageMessage 等消息类型。

发送消息

以客户端 A 向客户端 B 发送消息为例：

1. 客户端 A、B 分别创建自己的 ZIM 实例，并注册 setEventHandler 监听的 onReceivePeerMessage 回调接口，用于接收单聊消息通知。
2. 客户端 A、B 分别登录 ZIM SDK。
3. 客户端 A 调用 sendMessage 接口，设置 conversationType 为 ZIMConversationType.Peer 发送一条单聊消息到客户端 B。
4. 客户端 B 将通过 onReceivePeerMessage 回调接口，收到客户端 A 的消息。

public abstract void sendMessage(ZIMMessage message,
                                 String toConversationID,
                                 ZIMConversationType conversationType,
                                 ZIMMessageSendConfig config,
                                 ZIMMediaMessageSentCallback callback);

// 1、创建 ZIM 对象，传入 appID、appSign 与 Android 中的 Application
ZIMAppConfig appConfig = new ZIMAppConfig();
appConfig.appID = 12345;  //替换为您申请到的 AppID
appConfig.appSign = "appSign";   //替换为您申请到的 AppSign
zim = ZIM.create(appConfig, application);

// 2、设置 setEventHandler 回调
zim.setEventHandler(new ZIMEventHandler() {
    @Override
    public void onReceivePeerMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromUserID) {
        // 收到单聊消息的回调
    }
});

// 3、登录
ZIMUserInfo zimUserInfo = new ZIMUserInfo();
zimUserInfo.userID = "xxxx";
zimUserInfo.userName = "xxxx";
zim.login(zimUserInfo, new ZIMLoggedInCallback() {
    @Override
    public void onLoggedIn(ZIMError error) {
          // 开发者可根据 ZIMError 来判断是否登录成功。          
    }
 });

// 4、发送普通消息

String toConversationID = "xxxx1";

ZIMTextMessage zimMessage = new ZIMTextMessage();
zimMessage.message = "消息内容";

ZIMMessageSendConfig config = new ZIMMessageSendConfig();
// 设置消息优先级
config.priority = ZIMMessagePriority.LOW;
// 设置消息的离线推送配置
ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "离线推送的标题";
pushConfig.content= "离线推送的内容";
pushConfig.extendedData = "离线推送的扩展信息";
config.pushConfig = pushConfig;

// 设置发送的会话类型
// 发送单聊信息
ZIMConversationType type = ZIMConversationType.Peer;

// 发送群聊信息
// ZIMConversationType type = ZIMConversationType.Gourp;

// 发送房间信息
// ZIMConversationType type = ZIMConversationType.Room;

// 5、发送消息

zim.sendMessage(zimMessage, toConversationID, type,config, new ZIMMessageSentCallback() {
    @Override
    public void onMessageAttached(ZIMMessage zimMessage) {
        // 开发者可以通过该回调，监听消息是否开始准备发送。只有当通过本地基础参数检验的消息才会抛出该回调，否则通过 onMessageSent 回调抛出错误。
    }

    @Override
    public void onMessageSent(ZIMMessage zimMessage, ZIMError error) {
        // 开发者可以通过该回调监听消息是否发送成功。
    }
});

接收消息

zim.setEventHandler(new ZIMEventHandler() {
    @Override
    public void onReceivePeerMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromUserID) {
        // 收到“单聊”通信的消息回调
        for (ZIMMessage zimMessage : messageList) {
           if (zimMessage instanceof ZIMTextMessage) {
                ZIMTextMessage zimTextMessage = (ZIMTextMessage) zimMessage;
                Log.e(TAG, "收到的文本消息:"+ zimTextMessage.message);
           } else if (zimMessage instanceof ZIMCommandMessage) {
                ZIMCommandMessage zimCommandMessage = (ZIMCommandMessage) zimMessage;
                Log.e(TAG, "收到的信令消息:"+ zimCommandMessage.message);
           }    
        }
    }

    @Override
    public void onReceiveGroupMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromGroupID) {
        // 收到群组消息的回调
        for (ZIMMessage zimMessage : messageList) {
           if (zimMessage instanceof ZIMTextMessage) {
                ZIMTextMessage zimTextMessage = (ZIMTextMessage) zimMessage;
                Log.e(TAG, "收到的文本消息:"+ zimTextMessage.message);
           } else if (zimMessage instanceof ZIMCommandMessage) {
                ZIMCommandMessage zimCommandMessage = (ZIMCommandMessage) zimMessage;
                Log.e(TAG, "收到的信令消息:"+ zimCommandMessage.message);
           }    
        }
    }

    @Override
    public void onReceiveRoomMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromRoomID) {
        // 收到房间消息的回调
        for (ZIMMessage zimMessage : messageList) {
           if (zimMessage instanceof ZIMTextMessage) {
                ZIMTextMessage zimTextMessage = (ZIMTextMessage) zimMessage;
                Log.e(TAG, "收到的文本消息:"+ zimTextMessage.message);
           } else if (zimMessage instanceof ZIMCommandMessage) {
                ZIMCommandMessage zimCommandMessage = (ZIMCommandMessage) zimMessage;
                Log.e(TAG, "收到的信令消息:"+ zimCommandMessage.message);
           }    
        }
    }
});

收发富媒体消息

ZIM SDK 支持发送多种类型的富媒体消息，包含图片、文件、音频、视频等消息类型，开发者可以通过以下步骤实现富媒体文件消息的收发。

1. 用户登录成功后，指定消息类型（图片、文件、音频、视频）、会话类型（单聊、房间、群组）等，向指定会话发送富媒体消息。
2. 接收方用户登录成功后，根据会话类型（单聊、房间、群组）的相关回调监听，接收富媒体消息的相关通知，以及下载富媒体消息文件到本地。

发送富媒体消息

用户登录成功后，调用 sendMediaMessage 接口，指定会话、消息类型（图片、文件、音频、视频）、会话类型（单聊、房间、群组）、以及相关消息配置，向指定会话发送富媒体消息。

public abstract void sendMediaMessage(ZIMMediaMessage message,
                                      String toConversationID,
                                      ZIMConversationType conversationType,
                                      ZIMMessageSendConfig config,
                                      ZIMMediaMessageSentCallback callback);

// 发送富媒体消息消息示例 - 单聊 发送图片消息
ZIMImageMessage message = new ZIMImageMessage("/storage/emulated/0/Android/data/packagename/picture/xxx.jpg");
// 如果此处填了网络 URL，SDK 则会透传该路径，而不会经过 ZIM 后台服务处理，同时填入网络 URL 与本地路径，SDK 会优先认为用户想要使用网络 URL
message.setLargeImageDownloadUrl("url");
message.setFileDownloadUrl("url");
message.setThumbnailDownloadUrl("url");
ZIMMessageSendConfig config = new ZIMMessageSendConfig();
// 设置消息优先级
config.priority = ZIMMessagePriority.LOW;
// 设置消息的离线推送配置
// 不支持设置房间消息的离线推送配置，如果需要发送房间离线消息，请联系 ZEGO 技术支持开通相关权限
ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "离线推送的标题";
pushConfig.content= "离线推送的内容";
pushConfig.extendedData = "离线推送的扩展信息";
config.pushConfig = pushConfig;

zim.sendMediaMessage(message, toConversationID, ZIMConversationType.PEER, config, new ZIMMediaMessageSentCallback() {
    @Override
    public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {
        // 开发者可以通过该回调，监听消息是否开始准备发送。只有当通过本地基础参数检验的消息才会抛出该回调，否则通过 onMessageSent 回调抛出错误。               
    }

    @Override
    public void onMessageAttached(ZIMMediaMessage message){

    }

    @Override
    public void onMediaUploadingProgress(String fileUID, long currentFileSize, long totalFileSize, ZIMMediaMessage message) {
        // 开发者可以通过该回调监听消息是否发送成功。               
    }
});

// 发送富媒体消息消息示例 - 单聊 发送文件消息
ZIMFileMessage message = new ZIMFileMessage("/storage/emulated/0/Android/data/packagename/picture/xxx.zip");
// 如果此处填了网络 URL，SDK 则会透传该路径，而不会经过 ZIM 后台服务处理，同时填入网络 URL 与本地路径，SDK 会优先认为用户想要使用网络 URL
message.setFileDownloadUrl("url");
ZIMMessageSendConfig config = new ZIMMessageSendConfig();
config.priority = ZIMMessagePriority.HIGH;
zim.sendMediaMessage(message, conversationID, ZIMConversationType.PEER, config, new ZIMMediaMessageSentCallback() {
    @Override
    public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {

    }

    @Override
    public void onMessageAttached(ZIMMediaMessage message){

    }

    @Override
    public void onMediaUploadingProgress(String fileUID, long currentFileSize, long totalFileSize, ZIMMediaMessage message) {

    }
});

// 发送富媒体消息消息示例 - 单聊 发送音频消息
ZIMAudioMessage message = new ZIMAudioMessage("/storage/emulated/0/Android/data/packagename/picture/xxx.mp3", 300); // 这里的300只是举例，单位是秒。

// 如果此处填了网络 URL，SDK 则会透传该路径，而不会经过 ZIM 后台服务处理，同时填入网络 URL 与本地路径，SDK 会优先认为用户想要使用网络 URL
message.setFileDownloadUrl("url");
ZIMMessageSendConfig config = new ZIMMessageSendConfig();

ZIMMessageSendConfig config = new ZIMMessageSendConfig();
config.priority = ZIMMessagePriority.HIGH;
zim.sendMediaMessage(message, conversationID, ZIMConversationType.PEER, config, new ZIMMediaMessageSentCallback() {
    @Override
    public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {

    }

    @Override
    public void onMessageAttached(ZIMMediaMessage message){

    }

    @Override
    public void onMediaUploadingProgress(String fileUID, long currentFileSize, long totalFileSize, ZIMMediaMessage message) {

    }
});

// 发送富媒体消息消息示例 - 单聊 发送视频消息
ZIMVideoMessage message = new ZIMVideoMessage("/storage/emulated/0/Android/data/packagename/picture/xxx.mp4", 300);//这里单位是秒

// 如果此处填了网络 URL，SDK 则会透传该路径，而不会经过 ZIM 后台服务处理，同时填入网络 URL 与本地路径，SDK 会优先认为用户想要使用网络 URL
message.setFileDownloadUrl("url");
message.videoFirstFrameDownloadUrl("url");
ZIMMessageSendConfig config = new ZIMMessageSendConfig();
config.priority = ZIMMessagePriority.HIGH;
zim.sendMediaMessage(message, conversationID, ZIMConversationType.PEER, config, new ZIMMediaMessageSentCallback() {
    @Override
    public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {

    }

    @Override
    public void onMessageAttached(ZIMMediaMessage message){

    }

    @Override
    public void onMediaUploadingProgress(String fileUID, long currentFileSize, long totalFileSize, ZIMMediaMessage message) {

    }
});

富媒体文件消息的发送进度回调

开发者可以通过 onMediaUploadingProgress 回调，接收富媒体消息的上传发送进度的相关通知。

void onMediaUploadingProgress(String fileUID, long currentFileSize, long totalFileSize, ZIMMediaMessage message);

其中：

• message：正在发送消息的内容。
• currentFileSize：当前已被发送的消息大小。
• totalFileSize：发送消息的总体大小。

接收富媒体消息

接收方用户登录成功后，根据会话类型（单聊、房间、群组）的相关回调监听（onReceivePeerMessage、onReceiveRoomMessage、onReceiveGroupMessage），接收富媒体消息的相关通知，然后可以调用 downloadMediaFile 接口，下载富媒体消息文件到本地。

下载富媒体消息时，需要指定对应的媒体消息的文件类型。

• 图片消息：可以选择下载原始文件、大图、缩略图。
• 文件/音频消息：仅能选择下载文件/音频的原始文件。
• 视频消息：可以选择下载视频原始文件、视频首帧的缩略图。

public abstract void downloadMediaFile(ZIMMediaMessage message, ZIMMediaFileType fileType, ZIMMediaDownloadedCallback callback);

// 接收富媒体消息示例 - 单聊 接收富媒体消息
 @Override
    public void onReceivePeerMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromUserID) {
        super.onReceivePeerMessage(zim, messageList, fromUserID);
        for (ZIMMessage message : messageList) {
            // 收到消息时，可通过消息的 Type 进行判断接收到何种类型的消息
            if (message.getType() == ZIMMessageType.IMAGE) {
                // 获取图片消息
                ZIMImageMessage imageMessage = (ZIMImageMessage) message;
                zim.downloadMediaFile(imageMessage, ZIMMediaFileType.ORIGINAL_FILE, new ZIMMediaDownloadedCallback() {

                    @Override
                    public void onMediaDownloaded(ZIMMediaMessage message, ZIMError errorInfo) {
                        // 下载完成回调
                    }

                    @Override
                    public void onMediaDownloadingProgress(ZIMMediaMessage message, long currentFileSize, long totalFileSize) {
                        // 下载进度回调
                    }
                });
            } else if (message.getType() == ZIMMessageType.VIDEO) {
                // 获取视频消息
                ZIMVideoMessage videoMessage = (ZIMVideoMessage) message;
            } else if (message.getType() == ZIMMessageType.AUDIO) {
                // 获取音频消息
                ZIMAudioMessage audioMessage = (ZIMAudioMessage) message;
            } else if (message.getType() == ZIMMessageType.FILE) {
                // 获取文件消息
                ZIMFileMessage fileMessage = (ZIMFileMessage) message;
            }
        }
    }

富媒体文件消息的下载进度回调

开发者可以通过 onMediaDownloadingProgress 回调，接收富媒体消息的下载进度的相关通知。

void onMediaDownloadingProgress(ZIMMessage message, long currentFileSize, long totalFileSize);

其中：

• message：正在下载的消息内容。
• currentFileSize：当前已被下载的消息大小。
• totalFileSize：下载消息的总体大小。

收发信令消息

ZIM SDK 支持开发者实现信令类型的消息收发，开发者可以通过 ZIMCommandMessage 对象定义自己的消息类型，例如位置消息等。

以下以向指定用户发送信令消息为例。

发送信令消息

//向指定用户发送信令消息

// 1、创建 ZIM 对象，传入 appID、appSign 与 Android 中的 Application
// 具体代码请参考上文 [收发普通消息 - 发送消息] 相关代码。

// 2、设置 setEventHandler 回调
// 具体代码请参考上文 [收发普通消息 - 发送消息] 相关代码。

// 3、登录
// 具体代码请参考上文 [收发普通消息 - 发送消息] 相关代码。

// 4、发送信令信息
String userID = "xxxx";

ZIMCommandMessage zimCustomMessage = new ZIMCommandMessage();
zimCustomMessage.message = new byte[]{0x1,0x2,0x1,0x2};

ZIMMessageSendConfig config = new ZIMMessageSendConfig();
// 设置消息优先级
config.priority = ZIMMessagePriority.LOW;
// 设置消息的离线推送配置
// 不支持设置房间消息的离线推送配置，如果需要发送房间离线消息，请联系 ZEGO 技术支持开通相关权限
ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "离线推送的标题";
pushConfig.content= "离线推送的内容";
pushConfig.extendedData = "离线推送的扩展信息";
config.pushConfig = pushConfig;

// 发送单聊信息
ZIMConversationType type = ZIMConversationType.Peer;

// 发送群聊信息
// ZIMConversationType type = ZIMConversationType.Gourp;

// 发送房间信息
// ZIMConversationType type = ZIMConversationType.Room;

zim.sendMessage(zimCustomMessage, toConversationID, type,config, new ZIMMessageSentCallback() {
    @Override
    public void onMessageAttached(ZIMMessage zimMessage) {
        // 开发者可以通过该回调，监听消息是否开始准备发送。只有当通过本地基础参数检验的消息才会抛出该回调，否则通过 onMessageSent 回调抛出错误。               
    }

    @Override
    public void onMessageSent(ZIMMessage zimMessage, ZIMError error) {
        // 开发者可以通过该回调监听消息是否发送成功。
    }
});

接收信令消息

//用户接收信令消息
zim.setEventHandler(new ZIMEventHandler() {
    @Override
    public void onReceivePeerMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromUserID) {
        // 收到“单聊”通信的消息回调
        for (ZIMMessage zimMessage : messageList) {
            if (zimMessage instanceof ZIMCommandMessage) {
                ZIMCommandMessage zimCommandMessage = (ZIMCommandMessage) zimMessage;

           }    
        }
    }
});

收发自定义消息

ZIM SDK 支持开发者实现自定义类型的消息收发，开发者可以通过 ZIMCustomMessage 对象自行定义消息类型，例如投票类型、接龙类型、视频卡片类型等。开发者可以通过以下步骤实现自定义消息的收发。

发送自定义消息

发送自定义消息使用的接口为 sendMessage，与发送普通消息所用接口相同，开发者可参考 收发普通消息 - 发送消息 了解此接口参数详情。

开发者需要通过 ZIMCustomMessage 对象定义自定义类型消息，包括以下参数：

以下为用户在单聊会话中发送自定义消息的示例代码：

// 在单聊会话中向指定用户发送自定义消息

// 1、创建 ZIM 对象，传入 appID、appSign 与 Android 中的 Application
// 具体代码请参考上文 [收发普通消息 - 发送消息] 相关代码。

// 2、设置 setEventHandler 回调
// 具体代码请参考上文 [收发普通消息 - 发送消息] 相关代码。

// 3、登录
// 具体代码请参考上文 [收发普通消息 - 发送消息] 相关代码。

// 4、发送自定义信息
// 指定用户的 ID
String userID = "xxxx";

// 自定义消息的文本内容
String message = "";

// 具体的自定义类型
int subType = 100; 

// 自定义消息的检索字段。
String searchedContent = "";

ZIMCustomMessage zimCustomMessage = new ZIMCustomMessage(message,subType);

// 发送消息的高级属性配置
ZIMMessageSendConfig config = new ZIMMessageSendConfig();
// 设置消息优先级
config.priority = ZIMMessagePriority.LOW;

// 发送单聊信息
ZIMConversationType type = ZIMConversationType.Peer;

// 发送群聊信息
// ZIMConversationType type = ZIMConversationType.Gourp;

// 发送房间信息
// ZIMConversationType type = ZIMConversationType.Room;

zim.sendMessage(zimCustomMessage, toConversationID, type,config, new ZIMMessageSentCallback() {
    @Override
    public void onMessageAttached(ZIMMessage zimMessage) {
        // 开发者可以通过该回调，监听消息是否开始准备发送。只有当通过本地基础参数检验的消息才会抛出该回调，否则通过 onMessageSent 回调抛出错误。               
    }

    @Override
    public void onMessageSent(ZIMMessage zimMessage, ZIMError error) {
        // 开发者可以通过该回调监听消息是否发送成功。
    }
});

接收自定义消息

接收自定义消息的回调接口与接收普通消息的回调接口一致，请参考 收发普通消息 - 接收消息 了解具体接口。

以下为用户在单聊会话中接收自定义消息的示例代码：

// 用户在单聊会话中接收自定义消息
zim.setEventHandler(new ZIMEventHandler() {
    @Override
    public void onReceivePeerMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromUserID) {
        // 收到“单聊”消息的回调
        for (ZIMMessage zimMessage : messageList) {
            if (zimMessage instanceof ZIMCustomMessage) {
                ZIMCustomMessage zimCustomMessage = (ZIMCustomMessage) zimMessage;

           }    
        }
    }
});

收发 @ 消息

@ 消息，是指包含“@ + 用户”内容的消息。被 @ 的用户在收到消息时会强提醒。

发送 @ 消息

在调用 sendMessage 发送消息时，可以通过以下方法（可同时使用）将一条消息设置为 @ 信息：

• setMentionedUserIDs：提醒指定用户（可以是会话外用户）查看消息。传入的 userID 列表长度最多为 50，如需上调，请联系 ZEGO 技术支持。
• setIsMentionAll：提醒会话内所有其他用户查看消息。

// 以下为用户在单聊会话中发送 @ 消息的示例代码：

// 创建提醒用户列表
ArrayList<String> mentionArrayList = new ArrayList<>();

// 添加提醒用户（用户可以不在当前会话）
mentionArrayList.add("userId1");
mentionArrayList.add("userId2");

// message 可以为任何类型消息
// 调用接口提醒列表中用户查看消息
message.setMentionedUserIDs(mentionArrayList);

// 提醒会话内所有其他用户查看消息
boolean isMentionAll = true;
message.setIsMentionAll(isMentionAll);

ZIMMessageSendConfig config = new ZIMMessageSendConfig();
// 设置消息优先级
config.priority = ZIMMessagePriority.LOW;

// 是否强推送给被提醒用户（不管对方是否开启了会话免打扰），默认为fasle;
config.isNotifyMentionedUsers = true;

// 以发送单聊信息为例子
ZIMConversationType type = ZIMConversationType.Peer;

zim.sendMessage(message,"conv_id", type, config, new ZIMMessageSentCallback() {
    @Override
    public void onMessageAttached(ZIMMessage zimMessage) {
        // 开发者可以通过该回调，监听消息是否开始准备发送。只有当通过本地基础参数检验的消息才会抛出该回调，否则通过 onMessageSent 回调抛出错误。               
    }

    @Override
    public void onMessageSent(ZIMMessage zimMessage, ZIMError error) {
        // 开发者可以通过该回调监听消息是否发送成功。
    }
});

接收 @ 消息

接收 @ 消息的回调接口与接收普通消息的回调接口一致，请参考 收发普通消息 - 接收消息 了解具体接口。

收到消息后，开发者可根据业务逻辑实现对应的功能，如高亮等。

获取 mentionedInfoList

当会话内用户被提醒后，可以被动或主动获取 mentionedInfoList。

mentionedInfoList，包含 @ 消息的对应消息 ID，发送者 userID，以及 @ 消息的类型 ZIMMessageMentionedType，开发者可用于实现标记会话等多样业务逻辑。

被动获取

在用户被提醒时，会收到 onConversationChanged 回调，即可获取当前 ZIMConversation 的最新 mentionedInfoList。

@Override
    public void onConversationChanged(
        ZIM zim, ArrayList<ZIMConversationChangeInfo> conversationChangeInfoList) {
        // conversationChangeInfoList 可拿到收到提醒的会话里面的 mentionInfoList 
    }

主动获取

如用 queryConversationList 或者 queryConversation 主动拉取会话，也可获取会话里面的mentionedInfoList，可参考以下示例代码：

ArrayList<ZIMMessageMentionedInfo> mentionedInfoList = conversation.mentionedInfoList;

清除会话的 mentionedInfoList

接收 @ 消息后，用户需要清除会话的 mentionedInfoList，才能不再被提醒。

清除会话的 mentionedInfoList 接口与清除会话消息未读数接口相同：

• clearConversationUnreadMessageCount：清除单个会话消息未读数，调用示例请参考 会话管理 - 清除单个会话消息未读数。
• clearConversationTotalUnreadMessageCount：清除全部会话消息未读数，调用示例请参考 会话管理 - 清除全部会话消息未读数。

获取提醒用户列表

会话内所有用户都可以调用 getMentionedUserIDs 接口。获取具体提醒用户列表，可此接口仅能返回调用 setMentionedUserIDs 接口传入的用户列表。

ArrayList<String> userIds = message.getMentionedUserIDs();

确认是否为全员提醒

会话内所有用户都可以调用 isMentionAll 接口，确认消息是否为全员提醒消息。

boolean isMentionAll = message.isMentionAll();

收发全员推送消息

ZIM 支持您通过服务端向 App 所有在线用户发送消息，目标用户通过客户端接收相关消息。

从服务端向所有用户发送消息

请查看服务单 API 文档 全员推送 文档，实现从服务端向所有用户发送消息。

接收服务端发送的全员推送消息

通过 onBroadcastMessageReceived 回调，即可接收全员推送消息。

示例代码：

// 用户接收全员推送消息
public void onBroadcastMessageReceived(ZIM zim, ZIMMessage message) {
    super.onBroadcastMessageReceived(zim, message);
    // 接收到全员推送消息
}

转发消息

ZIM SDK 支持实现以下两种形式的消息转发：

• 合并消息后转发。
• 逐条消息转发。

具体实现流程，请参考 转发消息。

接收 Tips 消息

ZIM SDK 支持用户在会话内的操作转换为 Tips 消息。当相关操作出现后，ZIM SDK 会向会话发送一条 Tips 消息进行通知，详情请参考 接收 Tips 消息。

监听消息状态

在一些弱网场景中，可能存在以下场景，即消息发送成功，但由于某些因素（如网络丢包），导致 ZIM SDK 未收到服务端应答。此时，ZIM SDK 会因应答超时而认为消息发送失败，但实际上消息发送成功，导致消息状态混乱。为解决该问题，明确消息最终状态， 2.6.0 或以上版本 SDK 支持开发者监听 onMessageSentStatusChanged 回调，接收消息的状态变化。消息的状态有三种，即 Sending、Success 和 Failed。根据消息状态的变化，开发者可判断消息发送是否成功，并在业务上做相应处理。

// 监听消息状态
zim.setEventHandler(new ZIMEventHandler() {
    @Override
    public void onMessageSentStatusChanged(
        ZIM zim, ArrayList<ZIMMessageSentStatusChangeInfo> messageSentStatusChangeInfoList) {
    // 开发者可在这里监听消息状态改变时的回调。
}
});