浏览 SDKs · WASM
平台
SDKsWASM商业版

更新会话分组

更新会话分组的名称、扩展字段或隐藏状态。

复制

调用 updateConversationGroup() 可修改已有会话分组的基础属性。通过 conversationGroupID 指定目标分组,其余字段仅需传入本次需要更新的项即可。

参数说明

参数类型是否必填说明
conversationGroupIDstring是要更新的会话分组 ID。
namestring否新的分组名称。
exstring否业务自定义的分组扩展字符串。
hiddenboolean否是否隐藏该分组。
const { data: group } = await openimsdk.updateConversationGroup({
  conversationGroupID,
  name: '重点工作',
  hidden: false,
});

返回结果

接口调用成功后,返回的 data 为修改后的最新 ConversationGroup 对象。业务层可根据 conversationGroupID 直接替换本地列表中的分组数据。完整字段结构请参考查询会话分组列表。

此外,当前端或其他登录端随后会收到 SdkEvent.OnConversationGroupChanged 事件通知。完整的事件监听配置请参考会话分组概览。