OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · uni-app / uni-app x
Platform
SDKsuni-app / uni-app xEnterprise

Delete a conversation group

Delete a conversation group and its member associations without affecting conversations or messages.

Copy

Deleting conversation groups is a Commercial Edition capability. This operation deletes the conversation group and its membership associations; it does not delete member conversations or chat messages.

Parameters

ParameterTypeRequiredDescription
conversationGroupIDstringYesIdentifier of the conversation group to delete.

Code example

import { deleteConversationGroup } from '@/uni_modules/unix-openim-sdk'

await deleteConversationGroup({
  conversationGroupID,
})

The conversationGroupID parameter refers to the conversation category ID, not an OpenIM chat groupID.

Return value

The Promise resolves with void upon successful completion.

State changes after the call

Promise resolution indicates that the deletion was committed. Remove the group and its tab views from local state using conversationGroupID as the key. For event listeners and state synchronization upon reconnecting, see Conversation group overview.