浏览 SDKs · WASM
SDKsWASM

设置群组全员禁言

开启或关闭群组整体禁言。

复制

changeGroupMute() 控制群组整体禁言。群主和管理员可以按 OpenIMServer 权限执行该操作。

参数说明

参数类型是否必填说明
groupIDstring目标群组 ID。
isMutebooleantrue 开启,false 关闭。
muteBypassUserIDs 商业版string[]禁言期间仍允许发言的用户 ID。
await openimsdk.changeGroupMute({
  groupID,
  isMute: true,
  muteBypassUserIDs: [serviceAccountUserID],
});

不要把全部成员传入 muteBypassUserIDs。群主和管理员通常仍可发送消息,因此群组禁言不表示所有用户都无法发言。

返回结果

Promise 成功表示服务端完成本次群禁言设置。群资料随后可能通过 OnGroupInfoChanged 到达,应按 groupID 合并;完整监听见群组概览。需要立即校准时重新查询群资料。