获取历史消息

获取历史消息可以仅从本地数据中获取，仅从远端获取，和同时从本地与远端获取。

开通服务

从远端获取单群聊历史消息是指从融云服务端获取历史消息，该功能要求 App Key 已启用融云提供的单群聊消息云端存储服务。您可以在控制台 IM 服务的服务购买页面为当前使用的 App Key 开启服务。如果使用生产环境的 App Key，请注意仅 IM 旗舰版或 IM 尊享版可开通该服务。具体功能与费用以融云官方价格说明页面及计费说明文档为准。

提示

请注意区分历史消息记录与离线消息^?。融云针对单聊、群聊、系统消息默认提供最多 7 天（可调整）的离线消息缓存服务。客户端上线时 SDK 会自动收取离线期间的消息，无需 App 层调用 API。

从本地数据库中获取消息

从本地数据库中获取单条消息：消息 messageId

您可以根据消息 messageId 从本地数据库中获取单条消息。

接口原型

TypeScript

public getMessageById(messageId: number): Promise<IAsyncResult<Message>>;

参数说明

参数	类型	说明
messageId	number	消息的 ID

示例代码

TypeScript

let messageId = 123;
IMEngine.getInstance().getMessageById(messageId).then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }

    // 消息体
    let msg = result.data as Message;

});

从本地数据库中获取单条消息：消息 msgUid

您可以根据消息 msgUid 从本地数据库中获取单条消息。

接口原型

TypeScript

public getMessageByUid(messageUid: string): Promise<IAsyncResult<Message>>;

参数说明

参数	类型	说明
msgUid	string	消息 唯一 id，发送成功的消息才有 uid

示例代码

TypeScript

let msgUid = "CG5U-IGFN-F6S6-CVTR";
IMEngine.getInstance().getMessageByUid(msgUid).then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }
    // 消息体
    let msg = result.data as Message;
});

从本地数据库中分页获取批量消息：消息 meeeageId

您可以查询指定会话存储在本地数据库中的历史消息，并返回消息对象列表。

接口说明

TypeScript

public getHistoryMessagesById(conId: ConversationIdentifier, option: IGetLocalMsgByIdOption): Promise<IAsyncResult<List<Message>>>;

参数说明

参数名	类型	详细说明
conId	ConversationIdentifier	会话标识对象，包含会话类型和会话 targetId
option	IGetLocalMsgByIdOption	消息查询配置选项

参数 IGetLocalMsgByIdOption 的详细描述

TypeScript

/**
 * 获取本地消息的配置
 *
 * beforeCount afterCount 总共分为四种情况
 * ```
 * 1. beforeCount > 0 && afterCount > 0，将获取 beforeCount + {messageId} + afterCount 的消息
 * 2. beforeCount > 0 && afterCount == 0，将获取 beforeCount + {messageId} 的消息
 * 3. beforeCount == 0 && afterCount > 0，将获取 {messageId} + afterCount 的消息
 * 4. beforeCount == 0 && afterCount == 0，将获取 {messageId}
 * ```
 * @version 1.0.0
 */
interface IGetLocalMsgByIdOption {
  /**
   * objectName 集合，为空的话代表获取所有类型的本地消息
   *
   * 有效值的话代表获取指定类型的消息
   */
  objNameList?: List<string>,

  /**
   * 消息本地数据库 ID
   */
  messageId: number,

  /**
   * 在 messageId 之前的消息个数，取值 ≥0
   * @discussion beforeCount 如果传入 10 ，但是获取的个数不足时说明往前没有更多的消息了
   */
  beforeCount: number,

  /**
   * 在 messageId 之后的消息个数，取值 ≥0
   * @discussion afterCount 如果传入 10 ，但是获取的个数不足时说明往后没有更多的消息了
   */
  afterCount: number,
}

示例代码

TypeScript

let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";

let option: IGetLocalMsgByIdOption = {
  objNameList: objNameList,
  messageId: messageId,
  beforeCount: beforeCount,
  afterCount: afterCount
}

IMEngine.getInstance().getHistoryMessagesById(conId, option).then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }
    // 消息体
    let msg = result.data as List<Message>;
});

从本地数据库中分页获取批量消息：时间戳

您可以根据时间戳查询指定会话存储在本地数据库中的历史消息，并返回消息对象列表。

接口原型

TypeScript

public getHistoryMessagesByTime(conId: ConversationIdentifier, option: IGetLocalMsgByTimeOption): Promise<IAsyncResult<List<Message>>>;

参数说明

参数名	类型	详细说明
conId	ConversationIdentifier	会话标识对象，需包含有效的会话类型和会话 targetId
option	IGetLocalMsgByTimeOption	基于时间范围的消息查询配置

参数 IGetLocalMsgByTimeOption 的详细描述

TypeScript

/**
 * 获取本地消息的配置
 *
 * beforeCount afterCount 总共分为四种情况
 * ```
 * 1. beforeCount > 0 && afterCount > 0，将获取 beforeCount + {time} + afterCount 的消息
 * 2. beforeCount > 0 && afterCount == 0，将获取 beforeCount + {time} 的消息
 * 3. beforeCount == 0 && afterCount > 0，将获取 {time} + afterCount 的消息
 * 4. beforeCount == 0 && afterCount == 0，将获取 {time}
 * ```
 * @version 1.0.0
 */
interface IGetLocalMsgByTimeOption {
  /**
   * objectName 集合，为空的话代表获取所有类型的本地消息
   *
   * 有效值的话代表获取指定类型的消息
   */
  objNameList?: List<string>,

  /**
   * 毫秒时间戳
   * 初次可以传入当前时间: Date.now() 或者传入会话的 lastSentTime
   * @see Conversation
   */
  time: number,

  /**
   * 在 messageId 之前的消息个数，取值 ≥0
   * @discussion beforeCount 如果传入 10 ，但是获取的个数不足时说明往前没有更多的消息了
   */
  beforeCount: number,

  /**
   * 在 messageId 之后的消息个数，取值 ≥0
   * @discussion afterCount 如果传入 10 ，但是获取的个数不足时说明往后没有更多的消息了
   */
  afterCount: number,
}

示例代码

TypeScript

let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";

let option: IGetLocalMsgByTimeOption = {
  objNameList: objNameList,
  time: time,
  beforeCount: beforeCount,
  afterCount: afterCount
}

IMEngine.getInstance().getHistoryMessagesByTime(conId, option)
  .then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }
    // 消息列表
    let msgList = result.data as List<Message>;
  });

获取本地批量未读 @ 消息

接口原型

TypeScript

public getUnreadMentionedMessages(conId: ConversationIdentifier, option: ICountOption): Promise<IAsyncResult<List<Message>>>;

参数说明

参数名	类型	详细说明
conId	ConversationIdentifier	会话唯一标识对象，需包含有效的会话类型和会话 ID
option	ICountOption	未读提及消息查询配置

参数 ICountOption 的详细描述

TypeScript

/**
 * 个数配置
 * @version 1.0.0
 */
interface ICountOption {
  /**
   * 消息个数
   */
  count: number,

  /**
   * 获取数据顺序
   * @see Order
   */
  order: Order,
}

示例代码

TypeScript

let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";

let option: ICountOption = {
  count: 5,
  order: Order.Descending
};


IMEngine.getInstance().getUnreadMentionedMessages(conId, option)
  .then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }
    // 消息列表
    let msgList = result.data as List<Message>;
  });

获取本地第一条未读消息

示例代码

TypeScript

let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";


IMEngine.getInstance().getFirstUnreadMessage(conId)
  .then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }

    let msg = result.data as Message;
  });

获取远端历史消息

您可以使用 getRemoteHistoryMessages 方法可直接查询指定会话存储在单群聊消息云端存储中的历史消息。

提示

• 用户是否可以获取在加入群组之前的群聊历史消息取决于 App 在控制台的设置。您可以在控制台的功能配置页面，启用新用户获取加入群组前历史消息。启用此选项后，新入群用户可以获取在他们加入群组之前发送的所有群聊消息。如不启用，新入群用户只能看到他们入群后的群聊消息。
• 默认情况下，用户不在群组中不能获取群组中的历史消息。如果您希望用户未在指定群组中时，也可以获取群组历史消息，可以在融云控制台，在 IM 服务>功能配置>单群聊>用户不在群组时是否可以拉取历史消息，允许不在群组的用户也可以获取该群组的的历史消息。

获取远端批量消息

接口原型

TypeScript

public getRemoteHistoryMessages(conId: ConversationIdentifier, option: IGetRemoteMsgOption): Promise<IAsyncResult<List<Message>>>;

参数说明

参数名	类型	详细说明
conId	ConversationIdentifier	会话唯一标识对象，需包含有效的会话类型和会话 ID
option	IGetRemoteMsgOption	云端历史消息查询配置

参数 IGetRemoteMsgOption 的详细描述

TypeScript

/**
 * 获取远端消息配置
 * @version 1.0.0
 */
interface IGetRemoteMsgOption {
  /**
   * 毫秒时间戳
   * 初次可以传入当前时间: Date.now() 或者传入 Conversation.lastSentTime
   */
  time: number,

  /**
   * 消息个数，[1 ~ 100]
   */
  count: number,

  /**
   * 获取的消息顺序
   *
   * Descending： 获取比 time 小的消息列表
   *
   * Ascending：获取比比 time 大的消息列表
   */
  order: Order,

  /**
   * 是否包含本地已存在消息
   *
   * @discussion true: 拉取回来的消息全部返回 ; false: 拉取回来的消息只返回本地数据库中不存在的
   */
  isCheckDup: boolean,
}

示例代码

TypeScript

let conId = new ConversationIdentifier();
conId.conversationType = ConversationType.Private;
conId.targetId = "会话 id";

let option: IGetRemoteMsgOption = {
  time: time,
  count: 10,
  order: Order.Descending,
  isCheckDup: true
}

IMEngine.getInstance().getRemoteHistoryMessages(conId, option).then(result => {
    if (EngineError.Success !== result.code) {
      // 获取消息失败
      return;
    }
    if (!result.data) {
      // 消息不存在
      return;
    }
    // 消息列表
    let msgList = result.data as List<Message>;
});

获取本地与远端历史消息

提示

该接口在 IMEngine 类中提供。注意：用户是否可以获取在加入群组之前的群聊历史消息取决于 App 在控制台的设置。您可以在控制台的功能配置页面，启用新用户获取加入群组前历史消息。启用此选项后，新入群用户可以获取在他们加入群组之前发送的所有群聊消息。如不启用，新入群用户只能看到他们入群后的群聊消息。

getMessages 方法与 getRemoteHistoryMessages 的区别是 getMessages 会先查询指定会话存储本地数据库的消息，当本地消息无法满足查询条件时，再查询在单群聊消息云端存储中的历史消息，以返回连续且相邻的消息对象列表。

参数说明

• getMessages 接口的参数说明：

参数	类型	说明
conId	ConversationIdentifier	会话信息
option	IHistoryMessageOption	获取历史消息的配置选项

• IHistoryMessageOption 说明：

  参数	说明
  sendTime	待查询消息的发送时间，若为 0 则代表最近一条消息的发送时间，取值范围 [0, INT64_MAX]
  count	待查询消息的个数，取值范围 [1, 100]，不能为负数或者 0
  order	待查询消息的返回排序。Ascending：升序，拉取比 send_time 时间戳大的消息；Descending：降序，拉取比 send_time 时间戳小的消息;

HistoryMessageOption 默认按消息发送时间升序查询会话中的消息。升序查询消息一般可用于跳转到会话页面指定消息位置后需要查询更新的历史消息的场景。

如需按消息发送时间降序查询会话中的消息，建议获取返回结果中的 nextTime，并在下一次调用时作为 dateTime 的值传入，以便遍历整个会话的消息历史记录。

• HistoryMessageResult 返回结果说明：

参数	说明
messageArray	消息数组
nextTime	下次查询开始时间
hasMore	是否还有更多内容
crediable	是否确信

示例代码

TypeScript

let conId = new ConversationIdentifier();
   conId.conversationType = ConversationType.Private;
   conId.targetId = "TestTargetId"; // 按需填写实际的会话 id
   
   let option: IHistoryMessageOption = {
      sendTime: 0,
      count: 100,
      order: Order.Descending 
   }
   
   IMEngine.getInstance().getMessages(conId, option).then(result => {
       if (EngineError.Success !== result.code) {
           // 获取历史消息失败
           return;
       }
       if (!result.data) {
           // 获取历史消息为空
           return;
       }
       // 获取到有效的历史消息
       let dbMsg = result.data as HistoryMessageResult;
   })