获取历史消息

大约 5 分钟

获取历史消息

本文介绍环信即时通讯 IM SDK 如何从服务器和本地获取历史消息。

  • 环信即时通讯 IM 提供消息漫游功能，即将用户的所有会话的历史消息保存在消息服务器，用户在任何一个终端设备上都能获取到历史信息，使用户在多个设备切换使用的情况下也能保持一致的会话场景。

  • SDK 内部使用 SQLite 保存本地消息，你可以获取本地消息。

实现原理

使用环信即时通讯 IM SDK 可以通过 IChatManager 和 Conversation 类的以下方法从服务器获取和删除历史消息：

  • IChatManager.FetchHistoryMessagesFromServerBy 根据 FetchServerMessagesOption 类分页获取服务器保存的指定会话中的消息。
  • Conversation.LoadMessages 读取本地指定会话的消息。
  • IChatManager.LoadMessage 根据消息 ID 获取消息。
  • Conversation.LoadMessagesWithMsgType 获取本地单个会话中特定类型的消息。
  • Conversation.LoadMessagesWithTime 获取本地单个会话中一定时间段内的消息。
  • Conversion#MessagesCount 获取 SDK 本地数据库中会话某个时间段内的全部消息数。

前提条件

开始前，请确保满足以下条件：

  • 完成 SDK 初始化，并连接到服务器，详见 快速开始。
  • 了解环信即时通讯 IM API 的使用限制，详见 使用限制。

实现方法

从服务器获取指定会话的消息

你可以调用 FetchHistoryMessagesFromServerBy 方法基于 FetchServerMessagesOption 类从服务端分页拉取单聊和群组聊天的历史消息（消息漫游）。为确保数据可靠，我们建议你每次获取 20 条消息，最大不超过 50。分页查询时，若满足查询条件的消息总数大于 pageSize 的数量，则返回 pageSize 数量的消息，若小于 pageSize 的数量，返回实际条数。消息查询完毕时，返回的消息条数小于 pageSize 的数量。

通过设置 FetchServerMessagesOption 类，你可以根据以下条件拉取历史消息：

  • 消息发送方；
  • 消息类型；
  • 消息时间段；
  • 消息搜索方向；
  • 是否将拉取的消息保存到数据库；
  • 对于群组聊天，你可以设置 from 参数拉取群组中单个成员发送的历史消息。

提示

  1. 若使用该 API，需将 SDK 升级至 V1.2.0 或以上版本。
  2. 默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 1.3.0 版本，并联系环信商务。
  3. 拉取服务器漫游消息时会读取服务端的消息已读和送达状态。该功能只适用于单聊消息，默认关闭，如果需要，请联系环信商务开通。
  4. 历史消息在服务器上的存储时间与产品的套餐包相关，详见 IM 套餐包功能对比。
  FetchServerMessagesOption option = new FetchServerMessagesOption();
  // 消息搜索方向。`UP` 表示按消息时间戳递减的方向获取，即先获取最新消息；`DOWN` 表示按消息时间戳递增的方向获取，即先获取最老的消息。
  option.Direction = MessageSearchDirection.UP;
  //消息发送方的用户 ID, 仅用于群组消息，即当 `FetchHistoryMessagesFromServerBy` 中的 `type` 为 `ConversationType.Group` 时使用。
  option.From = "xxx";
  // 要获取的消息类型的数组。若不传值，会获取所有类型的消息。
  option.MsgTypes = new List<MessageBodyType>() { MessageBodyType.TXT };
  // 查询的起始时间戳，单位为毫秒。
  option.StartTime = 1709284487000;
  // 查询的结束时间戳，单位为毫秒。
  option.EndTime = 1709284499000;

  // conversationId 单聊为对端用户 ID，群组聊天为群组 ID，聊天室聊天为聊天室 ID。
  // type: 会话类型：单聊和群组聊天分别为 `Chat`, `Group`, `Room`。
  // cursor: 查询的起始消息 ID。若该参数设置为空字符串，从最新消息开始。
  // pageSize: 每页期望获取的消息条数。取值范围为 [1,50]，默认值为 10。
  // option: `FetchServerMessagesOption` 类型的查找选项。
  SDKClient.Instance.ChatManager.FetchHistoryMessagesFromServerBy(conversationId, type:ConversationType.Group, cursor:"", pageSize:10, option, new ValueCallBack<CursorResult<Message>>(
      onSuccess: (result) =>
      {
          if (0 == result.Data.Count)
          {
              return;
          }
          foreach (var msg in result.Data)
          {
              //process every msg
          }
      },
      onError: (code, desc) =>
      {
      }
  ));

此外，你还可以调用 FetchHistoryMessagesFromServer 方法从服务器获取指定会话的消息。

为确保数据可靠，我们建议你多次调用该方法，且每次获取的消息数小于 50 条。获取到数据后，SDK 会自动将消息更新到本地数据库。

SDKClient.Instance.ChatManager.FetchHistoryMessagesFromServer(conversationId, type, startId, pageSize, new ValueCallBack<CursorResult<Message>>(
    // 获取历史消息成功。
    // result 为 CursorResult<Message> 类型。
    onSuccess: (result) => {
    },

    // 获取历史消息失败。
    onError:(code, desc) => {
    }
));

从本地读取指定会话的消息

你可以从本地数据库中读取指定会话的消息，示例代码如下：

// 获取本地会话。
Conversation conv = SDKClient.Instance.ChatManager.GetConversation(conversationId, convType);
// 该方法获取 `startMsgId` 之前的 `pagesize` 条消息。
conv.LoadMessages(startMsgId, pagesize, callback:new ValueCallBack<List<Message>>(
  onSuccess: (list) => {
     Debug.Log($"获取到{list.Count}条消息");
  },
  onError:(code, desc) => {
     Debug.Log($"获取会话消息失败，errCode={code}, errDesc={desc}");
  }
));

根据消息 ID 获取本地消息

你可以调用 LoadMessage 方法根据消息 ID 获取本地存储的指定消息。如果消息不存在会返回空值。

// msgId：要获取消息的消息 ID。
Message msg = SDKClient.Instance.ChatManager.LoadMessage("msgId");

获取本地会话中特定类型的消息

你可以调用 LoadMessagesWithMsgType 方法从本地存储中获取指定会话中特定类型的消息。

每次最多可获取 400 条消息。若未获取到任何消息，SDK 返回空列表。

Conversation conv = SDKClient.Instance.ChatManager.GetConversation("convId");
// type：消息类型；count：每次获取的消息数量，取值范围为 [1,400]；direction：消息搜索方向：（默认）`UP`：按消息时间戳的逆序搜索；`DOWN`：按消息时间戳的正序搜索。
conv.LoadMessagesWithMsgType(type: MessageBodyType.TXT, count: 50, direction: MessageSearchDirection.UP, new ValueCallBack<List<Message>>(
    onSuccess: (list) => {
        // 遍历消息列表
        foreach(var it in list)
        {
        }
    },
    onError: (code, desc) => {
    }
));

获取一定时间内本地会话的消息

你可以调用 LoadMessagesWithTime 方法从本地存储中搜索一定时间段内指定会话中发送和接收的消息。

每次最多可获取 400 条消息。

Conversation conv = SDKClient.Instance.ChatManager.GetConversation("convId");
// startTime：搜索的起始时间戳；endTime：搜索的结束时间戳；count：每次获取的消息数量，取值范围为 [1,400]。
conv.LoadMessagesWithTime(startTime: startTime, endTime: endTime, count: 50, new ValueCallBack<List<Message>>(
    onSuccess: (list) => {
        // 遍历消息列表
        foreach (var it in list)
        {
        }
    },
    onError: (code, desc) => {
    }
));

获取会话在一定时间内的消息数

你可以调用 GetMessageCount 方法从 SDK 本地数据库中获取会话在某个时间段内的全部消息数。

SDKClient.Instance.ChatManager.GetMessageCount(new ValueCallBack<int>(
    onSuccess: (count) => {
    },
    onError: (code, desc) => {
    }
));
环信 IM 文档 Version: 1.0.0 ©️环信