OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · React Native
Platform
SDKsReact Native

Mute entire group

Enable or disable group-wide muting with optional bypass users using the OpenIM React Native SDK.

Copy

Toggle group-wide muting to silence regular members in a group:

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

Parameters

ParameterTypeRequiredDescription
groupIDstringYesTarget group ID to mute or unmute.
isMutebooleanYesSet true to enable group-wide muting, or false to disable.
muteBypassUserIDsEnterprise <span className="enterprise-field-badge">Commercial</span>string[]NoList of member user IDs permitted to speak even when muting is active.

Do not pass all group members into muteBypassUserIDsEnterprise. Group owners and administrators bypass muting automatically based on server permissions.

Return value

A resolved Promise confirms that the group mute setting was applied on the server.

The update triggers the OnGroupInfoChanged event. Use groupID to update the group's mute status and bypass list in your local state store. For full event listeners, see Group overview.