logo
即时通讯
机器人
ZIM Audio
当前页

设置群禁言

GET

https://zim-api.zego.im/

通过该接口可以禁言或解禁群组全员或某些群角色。

接口调用成功后,群组内全体用户通过以下 ZIM SDK 的回调接口,得知哪些角色无法在该群组发言或可恢复发言:

iOSAndroidmacOSWindows
groupMutedInfoUpdatedonGroupMutedInfoUpdatedgroupMutedInfoUpdatedonGroupMutedInfoUpdated
Web小程序FlutterReact Native
groupMutedInfoUpdatedgroupMutedInfoUpdatedonGroupMutedInfoUpdatedgroupMutedInfoUpdated
uni-app | uni-app xHarmonyOS
groupMutedInfoUpdatedgroupMutedInfoUpdated
说明

IsAllMuted、MuteRoleList、Duration 都不传,则解除群组内所有用户的禁言状态。

如果 Duration 非 0,IsAllMuted 传了 false,则传入的 MuteRoleList 会覆盖之前设置的禁言角色列表。

参数 FromUserId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'

若 FromUserId 为管理员,则 MuteRoleList[] 不能包含 1(群主)。

说明
调用频率限制:20 次/秒

Request

Query Parameters

    Action string必填

    可选值: [MuteGroup]

    接口原型参数

    https://zim-api.zego.im/?Action=MuteGroup

    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。

    IsAllMuted boolean

    默认值: false

    是否全员禁言。不传则默认 false。

    MuteRoleList number[]

    禁言角色列表,单次请求最多禁言 20 个群角色。枚举如下:

    • 1: 群主。
    • 2: 管理员。
    • 3: 群成员。
    • 其他: 开发者自定义的群角色,建议大于 100。

    仅当 IsAllMuted 为 false 或不传时有意义

    Duration number

    禁言时长,不传默认为 0。

    • -1:永久。
    • 0:取消群组级别的所有禁言。
    • 大于 0:禁言时长,单位为秒。最大支持 30 天(2592000 秒)。 禁言有效期内,若再次设置禁言时长,以最近一次请求设置的时长延长禁言状态。

Responses

OK
Schema
    Code number

    返回码。

    以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

    返回码说明处理建议
    660000001业务类通用错误。请重试,或联系 ZEGO 技术支持。
    660000002参数错误。请检查请求参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660600001群组不存在。请确认 GroupID 是否正确。
    660600009获取群相关信息失败。请先确认 GroupID 是否正确。如果正确,请联系 ZEGO 技术支持。
    660600024FromUserId 不在群内。请检查 FromUserId 或添加 FromUserId 为群成员
    660600032FromUserId 没权限。FromUserId 需为群主或管理员。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。


ZEGO 签名生成器
Request
折叠所有
Base URL
https://zim-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query
query
query
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

设置群成员角色

Next

设置群成员禁言

当前页

返回到顶部