• 获取本地会话列表
• 获取远端会话列表
  • 参数说明
  • 代码示例

获取本地会话列表

Web 端不具备持久化的数据存储能力，故无法提供获取本地会话列表相关功能

获取远端会话列表

该功能需开发者开启 IM 商用版 - 单群聊云存储 (opens new window)功能才能生效。 该功能需要在调用 im.connect() 并且建立连接成功之后执行。 服务器会话列表存储上限为 1000 条会话

参数说明

输入参数说明

参数	类型	必填	默认值	说明	最低版本
count	Number	否	300	想要获取的会话列表数量，默认值 300，最大值 1000	3.0.0
startTime	Number	否	0	获取会话列表所使用的时间戳，需要精确到毫秒	3.0.7.1
order	Number	否	0	会话排序方式	3.0.7.1

order 说明:

value	说明
0	按会话生成时间倒序排列，即获取早于 startTime 生成的会话列表
1	按会话生成时间正序排列，即获取晚于 startTime 生成的会话列表

startTime 补充说明:

• startTime 为 0 且 order 为 0 时, startTime 表示当前时间点，接口将返回最新的会话列表
• startTime 为 0 且 order 为 1 时, startTime 表示会话列表的创建时间，即最早的一条消息的产生时间，接口将返回最早的会话列表数据

回调参数说明

回调参数	类型	说明
conversationList	Array	会话列表，会话参数说明请参照 conversation 属性说明

conversation 属性说明:

字段名	类型	说明
type	Number	会话类型
targetId	String	群组 ID
unreadMessageCount	Number	当前会话的未读消息数
latestMessage	Object	会话中最后一条消息
hasMentioned	Boolean	是否包含 @ 自己的消息
mentionedInfo	Object	@ 信息
notificationStatus	Number	当前会话免打扰状态
isTop	Boolean	当前会话免置顶状态

mentionedInfo 结构:

字段名	类型	说明
type	Number	@ 类型，1: @ 所有人， 2: @ 部分人
userIdList	Array	被 @ 的用户 id 列表

代码示例

im.Conversation.getList({
  count: 30,
  startTime: 0,
  order: 0
}).then(conversationList => {
  console.log('获取会话列表成功', conversationList);
});
已复制