SDKsWASM商业版

查询会话分组列表

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

调用 getConversationGroups() 可按分组类型获取当前登录用户的所有会话分组列表。

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

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

参数为 ConversationGroupType 枚举值：获取普通用户自定义分组时传入 ConversationGroupTypeNormal；获取包含系统筛选分组在内的全部类型时传入 ConversationGroupTypeAll。

返回结果

接口调用成功后，返回的 data 为符合条件的 ConversationGroup[] 数组。在界面渲染或缓存维护中，建议使用 conversationGroupID 作为唯一键标识各分组。

会话分组字段

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

ConversationGroup 对象中仅包含会话 ID 列表（conversationIDs），不包含完整的会话详情数据。若需直接分页获取分组及其下的详细会话对象，请使用查询分组内会话。

该接口为只读查询，用于拉取初始数据快照。后续的分组新增、修改与删除事件请参考会话分组概览。

这个页面有帮助吗？