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

***

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

# ~~Function: getConversationList()~~

> **getConversationList**(`options?`, `channelId?`): `Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`IAReceivedConversation`](../interfaces/IAReceivedConversation.md)[]\>\>

获取会话列表

5.20.0 变更：
* 1. 在开启会话列表支持超级群后，会话列表中会包含超级群会话；
* 2. Electron 平台下支持除 order 之外的查询参数，需指定 channelId 为 '' 或其他有效值；当值为 undefined 时，为向前兼容，其他参数将失效，该接口将返回全部会话列表

## Parameters

### options?

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

获取会话列表参数配置

### channelId?

`string`

该参数为单群聊会话的组织 ID，用于获取不同组织下的会话列表，非超级群 channelId 概念；该参数对 Web 平台无效

## Returns

`Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`IAReceivedConversation`](../interfaces/IAReceivedConversation.md)[]\>\>

返回一个 [RCResult](../interfaces/RCResult.md) 类型 Promise，data 结构为 [IAReceivedConversation](../interfaces/IAReceivedConversation.md) 类型数组

## Description

获取会话列表接口需要开通单群聊消息云存储之后才可以从服务端获取到数据，服务端会话列表存储上限为 1000

## Default Values

count: 300, startTime: 0, order: 0

## Example

获取会话列表示例：
```ts
const conversationList = await RongIMLib.getConversationList();
console.info('获取会话列表结果：', conversationList);
```

## Deprecated

请使用 [getConversationListByTimestamp](getConversationListByTimestamp.md) 替代