设置群成员禁言

描述

通过该接口可以禁言或解禁群组内的特定成员。

接口调用成功后，群组内全体用户通过以下 ZIM SDK 的回调接口，得知哪些群成员无法在该群组发言或解除禁言状态：

iOS	Android	macOS
groupMemberInfoUpdated	onGroupMemberInfoUpdated	groupMemberInfoUpdated

Windows	Web	小程序
onGroupMemberInfoUpdated	groupMemberInfoUpdated	groupMemberInfoUpdated

Flutter	uni-app x	uni-app
groupMemberInfoUpdated	onGroupMemberInfoUpdated	groupMemberInfoUpdated

React Native	HarmonyOS
groupMemberInfoUpdated	groupMemberInfoUpdated

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

说明

以下 FromUserId 和 UserIds 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或开发者已调用服务端 API 注册相关的 userID。

参数	类型	是否必选	描述
FromUserId	String	是	操作用户 ID（已在客户端调用 `login` 方法登录 ZIM 服务，或已调用服务端 API 完成注册）。说明由于禁言操作会触发群 tips 消息，因此当 FromUserId 不是群组成员时，开发者需要隐藏该消息或实现其他处理，避免群内用户产生困惑。
GroupId	String	是	群组 ID。
UserIds[]	Array of String	是	禁言或解禁群成员用户 ID 列表，单次请求最多传入 20 个用户 ID。
Duration	Number	否	禁言时长，不传默认为 0。 -1：永久。 0：取消禁言。大于 0：禁言时长，单位为秒。最大支持 30 天（2592000 秒）。若在某位群用户的禁言有效期内，再次调用本接口更新禁言时长，则以该请求时刻起重新计算禁言时间。

说明

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

Untitled

https://zim-api.zego.im/?Action=MuteGroupMembers
&<公共请求参数>
&FromUserId=user1   
&GroupId=group
&UserIds[]=user2
&UserIds[]=user3
&Duration=100000

Copied!

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
ErrorUsers	Array of Object	失败用户列表。 Code 为 0： ErrorUsers 为空，全部指定用户禁言/解禁成功。 ErrorUsers 不为空，表示部分用户禁言/解禁失败，请参考 SubCode 处理。 Code 不为 0： ErrorUsers 为空，表示参数错误、接口频率限制、系统错误。 ErrorUsers 不为空，表示所有用户都禁言/解禁失败。
└UserId	String	失败用户 ID。
└SubCode	Number	失败的具体返回码。

Untitled

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

Copied!

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

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