SDKsWASM商业版

创建会话分组

创建会话分组，并可选择同时加入一个会话。

调用 createConversationGroup() 可为当前登录用户创建一个新的会话分组。创建普通分组时只需传入分组名称；如果需要在创建时立即将某个会话归入该分组，可一并传入 conversationID。

参数说明

参数	类型	是否必填	说明
`name`	`string`	是	分组名称。
`order`	`number`	否	分组顺序值，排序规则由业务层约定。
`ex`	`string`	否	业务自定义的分组扩展字符串。
`conversationID`	`string`	否	创建后立即加入该分组的会话 ID。
`conversationGroupType`	`ConversationGroupType`	否	分组类型；普通自定义分组建议明确传入 `ConversationGroupTypeNormal`。

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

const { data: group } = await openimsdk.createConversationGroup({
  name: '工作',
  order: 100,
  conversationID,
  conversationGroupType: ConversationGroupType.ConversationGroupTypeNormal,
});

返回结果

接口调用成功后，返回的 data 为新建的 ConversationGroup 对象，业务层可直接使用其 conversationGroupID、name 及 conversationIDs 更新本地分组列表。完整数据结构请参考查询会话分组列表。

此外，当前端或其他登录端随后会收到 SdkEvent.OnConversationGroupAdded 事件通知。完整的事件监听与分组同步说明请参考会话分组概览。

这个页面有帮助吗？