[**RongIMLib**](../README.md)

***

[RongIMLib](../globals.md) / getHistoryMessages

# Function: getHistoryMessages()

> **getHistoryMessages**(`conversation`, `options?`): `Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`GetHistoryMessageResult`](../type-aliases/GetHistoryMessageResult.md)\>\>

获取历史消息

## Parameters

### conversation

[`IConversationIdentifier`](../interfaces/IConversationIdentifier.md)

会话信息

### options?

[`GetHistoryMessageOption`](../interfaces/GetHistoryMessageOption.md)

获取历史消息配置项，类型为 [GetHistoryMessageOption](../interfaces/GetHistoryMessageOption.md) 可选

## Returns

`Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`GetHistoryMessageResult`](../type-aliases/GetHistoryMessageResult.md)\>\>

## Description

获取历史消息，支持分页加载，可指定时间戳、数量、排序方式等参数进行分页获取。
 1. Count 最大值为 100，超过 100 时返回错误码 34232：开发者接口调用时传入的 count 非法
 2. 如果 `SDK < 5.7.4`，范围为 [1-20]；如果 SDK ≧ 5.7.4，范围为 [1-100]。默认值 `20`
**注意**：
 1. Electron 获取的是本地数据库
 2. Web 获取的是远端历史消息，Web 端不具备持久化的数据存储能力，无法在本地持久化存储历史消息记录与会话列表，因此需要从融云服务端获取数据。
 3. 请确保已开通单群聊消息云端存储服务，如未开通服务请移步到融云开发者后台的 IM 服务管理模块开启。

## Default Value

```ts
options = { timestamp: 0, count: 20, order: 0 }
```

## Example

获取历史消息示例：
```ts
const conversation = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId',
}
const messages = await RongIMLib.getHistoryMessages(conversation);
console.info('获取历史消息结果：', messages);