设置群禁言
https://zim-api.zego.im/
通过该接口可以禁言或解禁群组全员或某些群角色。
接口调用成功后,群组内全体用户通过以下 ZIM SDK 的回调接口,得知哪些角色无法在该群组发言或可恢复发言:
| iOS | Android | macOS | Windows | 
|---|---|---|---|
| groupMutedInfoUpdated | onGroupMutedInfoUpdated | groupMutedInfoUpdated | onGroupMutedInfoUpdated | 
| Web | 小程序 | Flutter | React Native | 
|---|---|---|---|
| groupMutedInfoUpdated | groupMutedInfoUpdated | onGroupMutedInfoUpdated | groupMutedInfoUpdated | 
| uni-app | uni-app x | HarmonyOS | 
|---|---|
| groupMutedInfoUpdated | groupMutedInfoUpdated | 
IsAllMuted、MuteRoleList、Duration 都不传,则解除群组内所有用户的禁言状态。
如果 Duration 非 0,IsAllMuted 传了 false,则传入的 MuteRoleList 会覆盖之前设置的禁言角色列表。
参数 FromUserId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'。
若 FromUserId 为管理员,则 MuteRoleList[] 不能包含 1(群主)。
Request
Query Parameters
- 1: 群主。
 - 2: 管理员。
 - 3: 群成员。
 - 其他: 开发者自定义的群角色,建议大于 100。
 - -1:永久。
 - 0:取消群组级别的所有禁言。
 - 大于 0:禁言时长,单位为秒。最大支持 30 天(2592000 秒)。 禁言有效期内,若再次设置禁言时长,以最近一次请求设置的时长延长禁言状态。
 
可选值: [MuteGroup]
接口原型参数
https://zim-api.zego.im/?Action=MuteGroup
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
可选值: <= 32 characters
操作用户 ID(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)。
说明
由于禁言操作会触发群 tips 消息,因此当 FromUserId 不是群组成员时,开发者需要隐藏该消息或实现其他处理,避免群内用户产生困惑。
可选值: <= 32 characters
群组 ID。
默认值: false
是否全员禁言。不传则默认 false。
禁言角色列表,单次请求最多禁言 20 个群角色。枚举如下:
仅当 IsAllMuted 为 false 或不传时有意义
禁言时长,不传默认为 0。
Responses
- 200
 
- application/json
 
- curl
 - python
 - go
 - nodejs
 - ruby
 - csharp
 - php
 - java
 - powershell
 
- CURL
 

