SDKsWASM

Change group mute status

Enable or disable group-wide mute.

changeGroupMute() controls group-wide mute. The owner and administrators can perform this operation subject to OpenIMServer permissions.

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group ID.
`isMute`	`boolean`	Yes	`true` to enable mute and `false` to disable it.
`muteBypassUserIDs` Enterprise	`string[]`	No	User IDs that may still speak while the group is muted.

await openimsdk.changeGroupMute({
  groupID,
  isMute: true,
  muteBypassUserIDs: [serviceAccountUserID],
});

Do not pass every member in muteBypassUserIDs. The owner and administrators can normally still send messages, so group-wide mute does not mean that every user is unable to speak.

A successful Promise means that the server completed the group mute update. The group profile may subsequently arrive through OnGroupInfoChanged; merge it by groupID. See Group overview for the complete listener. Query the group profile again when immediate reconciliation is required.

Was this page helpful?