文档中心
即时通讯
服务端 API
群组相关
移除群成员

移除群成员

更新时间：2024-02-27 17:36

描述

通过指定用户 ID 移除群内用户。

群内用户 ID 可通过查询群成员列表获取。
如果被移除的用户为群主，则群列表第一位用户会自动成为新群主。

成功移除用户后，全体群成员（包括群主自己、被移除的成员）会通过 ZIM SDK 回调接口收到群成员状态变更通知：

iOS	Android	macOS	Windows	Web
groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged
小程序	Flutter	Unity3D	uni-app	React Native
groupMemberStateChanged	onGroupMemberStateChanged	OnGroupMemberStateChanged	groupMemberStateChanged	groupMemberStateChanged

接口原型

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

请求参数

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

参数	类型	是否必选	描述
FromUserId	String	是	操作者的用户 ID。
GroupId	String	是	群组 ID。
UserId[]	Array of String	是	需要被移除的用户 ID 列表，最大支持 50 个用户 ID。示例："UserId": ["usera","userb"]。
CustomReason	String	否	移除原因，长度限制为 32 字节。

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

请求示例

请求地址 URL：

https://zim-api.zego.im/?Action=KickoutGroupUser
&<公共请求参数>

请求消息体：

{
   "FromUserId":"zego_user",
   "GroupId":"groupA",
   "CustomReason":"reason",
   "UserId":["userA"]
}

响应参数

参数	类型	描述
Code	Number	返回码。如果您发起请求同时移除多名用户时：如果成功移除 1 个或以上的用户，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。如果所有用户都没被成功移除，Code 会返回相关返回码，具体请参考全局返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
ErrorList	Array of String	失败列表。 Code 为 0： ErrorList 为空，全部指定用户移除成功。 ErrorList 不为空，表示部分指定用户移除失败，请参考 SubCode 处理。 Code 不为 0： ErrorList 为空，表示参数错误、接口频率限制、系统错误。 ErrorList 不为空，表示全部指定用户移除失败。
UserId	String	移除失败的用户 ID。
SubCode	Number	移除失败的错误码。

响应示例

{
   "Code":0,
   "Message":"success",
   "RequestId":"343649807833778782",
   "ErrorList": [
      {
         "UserId":"u2",
         "SubCode":660000012
      } 
   ]
}

返回码

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

返回码	说明	处理建议
660000002	参数错误。	请参考请求参数输入正确参数。
660000011	需要被移除的用户数量超过限制。	数量应不超过 50。
660600001	群不存在。	请确认 GroupId 是否正确。
660600005	调用 KickoutGroupUser 接口的频率超出限制。	调用频率为 20 次/秒，请勿超出限制。
660600008	需要被移除的用户不在群内。	用户已退出群，无需处理。
660600009	获取群相关信息失败，该群组可能不存在。	请先确认 GroupID 是否正确。如果正确，请联系 ZEGO 技术支持。