跳到主要内容

获取历史消息

开通服务​

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

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

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

获取历史消息​

开发者可以通过此接口来获取某个会话的历史消息。

方法​

getMessages(
  type: RCIMIWConversationType,
  targetId: string,
  channelId: string,
  sentTime: number,
  order: RCIMIWTimeOrder,
  policy: RCIMIWMessageOperationPolicy,
  count: number,
  callback: IRCIMIWGetMessagesCallback
): Promise<number>;

参数说明​

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
sentTimenumber当前消息时间戳
orderRCIMIWTimeOrder获取消息的方向。BEFORE：获取 sentTime 之前的消息 （时间递减），AFTER：获取 sentTime 之后的消息 （时间递增）
policyRCIMIWMessageOperationPolicy消息的加载策略。LOCAL：只加载本地，REMOTE：只加载远端，LOCAL_REMOTE：本地远端都加载
countnumber获取的消息数量，count 大于 0，小于等于 20。
callbackIRCIMIWGetMessagesCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例​

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getMessages(type, targetId, channelId, sentTime, order, policy, count, callback);

回调方法​

  • setOnMessagesLoadedListener
setOnMessagesLoadedListener(listener?: ({code, type, targetId, channelId, sentTime, order, messages}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码，0 代表成功，非 0 代表出现异常
typeRCIMIWConversationType会话类型
targetIdstring会话 ID
channelIdstring频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
sentTimenumber当前消息时间戳
orderRCIMIWTimeOrder获取消息的方向。BEFORE：获取 sentTime 之前的消息 （时间递减），AFTER：获取 sentTime 之后的消息 （时间递增）
messagesArray<RCIMIWMessage>获取到的消息集合

代码示例

engine.setOnMessagesLoadedListener((res) => {
    //...
});

通过 messageId 获取消息​

开发者可以通过此接口来获取某条消息。

方法​

getMessageById(
  messageId: number,
  callback: IRCIMIWGetMessageCallback
): Promise<number>;

参数说明​

参数名参数类型描述
messageIdnumber消息的 messageId，可在消息对象中获取
callbackIRCIMIWGetMessageCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例​

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getMessageById(messageId, callback);

通过 messageUId 获取消息​

开发者可以通过此接口来获取某条消息。

方法​

getMessageByUId(
  messageUId: string,
  callback: IRCIMIWGetMessageCallback
): Promise<number>;

参数说明​

参数名参数类型描述
messageUIdstring消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值。
callbackIRCIMIWGetMessageCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例​

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getMessageByUId(messageUId, callback);
最后于 更新