Browse SDKs · uni-app / uni-app x
SDKsuni-app

Change group mute status

OpenIM uni-app / uni-app x SDK guide for Change group mute status.

Copy

changeGroupMute() turns group-wide mute on or off.

Parameters

ParameterTypeRequiredDescription
groupIDstringYesGroup to update.
isMutebooleanYestrue enables group-wide mute; false disables it.
import { changeGroupMute } from '@/uni_modules/unix-openim-sdk'

await changeGroupMute({ groupID, isMute: true })

Only the owner or an administrator with server permission can perform this operation. The server still validates group state, role changes, and concurrent updates. Owners and administrators can normally keep sending, so group-wide mute does not necessarily silence every account.

Wasm's commercial muteBypassUserIDs extension is not present in the current uni-app / uni-app x contract. Do not pass that field. Even if a commercial server supports exceptions, rely on the exported plugin type and subsequent group snapshot.

Return result

The Promise resolves directly to a string result, meaning the server completed this mute request. It does not mean that every member UI updated. Merge onGroupInfoChanged by groupID or query the group again. Group-wide mute and an individual member's mute interval are separate capabilities.