SDKsWASM商业版

查询会话分组列表

按类型查询当前用户的会话分组。

使用 getConversationGroups() 按分组类型建立当前登录用户的会话分组快照。

import { ConversationGroupType } from '@openim/wasm-client-sdk';

const { data: groups } = await openimsdk.getConversationGroups(
  ConversationGroupType.ConversationGroupTypeNormal,
);

参数是一个 ConversationGroupType。查询普通自定义分组时传入 ConversationGroupTypeNormal；需要查询全部类型时传入 ConversationGroupTypeAll。

返回结果

Promise 成功后，data 是匹配类型的 ConversationGroup[]。渲染或缓存时应按 conversationGroupID 标识分组。

会话分组字段

字段	类型	说明
`conversationGroupID`	`string`	会话分组的稳定 ID，也是分组事件的合并标识。
`name`	`string`	分组名称。
`conversationGroupType`	`ConversationGroupType`	分组类型，例如普通自定义分组或筛选分组。
`conversationIDs`	`string[]`	当前分组直接包含的会话 ID。
`serial`	`number`	服务端保存的分组顺序值。
`hidden`	`boolean`	该分组是否隐藏。
`unreadCount`	`number`	分组内会话的汇总未读数。
`version`	`number`	分组数据版本，用于识别新旧快照。
`ex`	`string`（可选）	业务约定的分组扩展字符串。

分组只保存 conversationIDs，不包含完整会话资料。需要同时读取会话详情时，使用查询分组内会话。

该查询只建立调用时的快照，不会触发分组事件。后续变化通过事件增量合并，必要时重新查询校准；事件列表见会话分组概览。

这个页面有帮助吗？