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

***

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

# Function: getChatroomHistoryMessages()

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

获取聊天室的历史消息

## Parameters

### targetId

`string`

聊天室 ID

### options

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

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

## Returns

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

返回一个 [RCResult](../interfaces/RCResult.md) 类型 Promise，data 为 [GetHistoryMessageResult](../type-aliases/GetHistoryMessageResult.md) 类型

## Description

获取聊天室的历史消息接口要求开通 `聊天室消息云端存储服务`。使用前请确认已开通服务。开通后聊天室历史消息保存在云端，默认保存 2 个月

## Example

**获取聊天室的历史消息示例：**

```ts
const chatRoomId = 'chatroomId';
const options = {
 count: 10,
 order: 1,
 timestamp: 0,
};
const res = await RongIMLib.getChatroomHistoryMessages(chatRoomId, options);
console.log('获取聊天室的历史消息结果：', res);
```