MuteGroupMembers
GET
https://zim-api.zego.im/
通过该接口可以禁言或解禁群组内的特定成员。
接口调用成功后，群组内全体用户通过以下 ZIM SDK 的回调接口，得知哪些群成员无法在该群组发言或解除禁言状态：
| iOS | Android | macOS | Windows |
|---|---|---|---|
| groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| groupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnGroupMemberInfoUpdated | groupMemberInfoUpdated | groupMemberInfoUpdated |
说明
说明
参数 FromUserId 和 UserIds 仅支持数字，英文字符和
'!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'。说明
调用频率限制：20 次/秒。
Request
Query Parameters
- -1：永久。
- 0：取消禁言。
- 大于 0：禁言时长，单位为秒。最大支持 30 天（2592000 秒）。
Action string必填
可选值: [MuteGroupMembers]
接口原型参数
https://zim-api.zego.im/?Action=MuteGroupMembers
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
FromUserId string必填
可选值: <= 32 characters
操作用户 ID（已在客户端调用 login 方法登录 ZIM 服务，或已调用 服务端 API 完成注册）。
说明
由于禁言操作会触发群 tips 消息，因此当 FromUserId 不是群组成员时，开发者需要隐藏该消息或实现其他处理，避免群内用户产生困惑。
GroupId string必填
可选值: <= 32 characters
群组 ID。
UserIds string[]必填
可选值: <= 20
禁言或解禁群成员用户 ID 列表，单次请求最多传入 20 个用户 ID。
Duration number
可选值: >= -1 and <= 2592000
禁言时长，不传默认为 0。
若在某位群用户的禁言有效期内，再次调用本接口更新禁言时长，则以该请求时刻起重新计算禁言时间。
Responses
- 200
OK
- application/json