文档中心
即时通讯
服务端 API
群组相关
设置群禁言

设置群禁言

更新时间：2024-05-31 18:21

描述

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

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

iOS	Android	macOS	Windows	Web
groupMutedInfoUpdated	onGroupMutedInfoUpdated	groupMutedInfoUpdated	onGroupMutedInfoUpdated	groupMutedInfoUpdated
小程序	Flutter	uni-app	React Native
groupMutedInfoUpdated	onGroupMutedInfoUpdated	groupMutedInfoUpdated	groupMutedInfoUpdated

接口原型

请求方法：GET
请求地址：https://zim-api.zego.im/?Action=MuteGroup
传输协议：HTTPS
调用频率限制：20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	操作用户 ID。
GroupId	String	是	群组 ID。
IsAllMuted	Bool	否	是否全员禁言。不传则默认 false。
MuteRoleList[]	Array of Number	否（仅当 IsAllMuted 为 false 或不传时有意义）	禁言角色列表，单次请求最多禁言 20 个群角色。枚举如下： 1: 群主。 2: 管理员。 3: 群成员。其他: 开发者自定义的群角色，建议大于 100。
Duration	Number	否	禁言时长，不传默认为 0。 -1：永久。 0：取消群组级别的所有禁言。大于 0：禁言时长，单位为秒。最大支持 30 天（2592000 秒）。禁言有效期内，若再次设置禁言时长，以最近一次请求设置的时长延长禁言状态。

IsAllMuted、MuteRoleList、Duration 都不传，则解除群组内所有用户的禁言状态。
如果 Duration 非 0，IsAllMuted 传了 false，则传入的 MuteRoleList 会覆盖之前设置的禁言角色列表。
FromUserId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，'{'，'}'，'|'，'~'。
若 FromUserId 为管理员，则 MuteRoleList[] 不能包含 1（群主）。

请求示例

https://zim-api.zego.im/?Action=MuteGroup
&<公共请求参数>
&FromUserId=user1
&GroupId=group
&IsAllForbid=false
&MuteRoleList[]=2
&MuteRoleList[]=3
&Duration=100000

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

返回码

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

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