移除群成员

POST

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

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

说明

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

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

iOS	Android	macOS	Windows
groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged

Web	小程序	Flutter	React Native
groupMemberStateChanged	groupMemberStateChanged	onGroupMemberStateChanged	groupMemberStateChanged

Unity3D	uni-app \| uni-app x	HarmonyOS
OnGroupMemberStateChanged	groupMemberStateChanged	groupMemberStateChanged

说明

参数 FromUserId 和 UserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册。

说明

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

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [KickoutGroupUser]

接口原型参数

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

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

操作者的用户 ID。

GroupId string必填

可选值: <= 32 characters

群组 ID。

UserId string[]必填

可选值: <= 50

需要被移除的用户 ID 列表，最大支持 50 个用户 ID。

示例："UserId": ["usera","userb"]。

CustomReason string

移除原因，最长 32 字节。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code number

返回码。

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

说明

如果您发起请求同时移除多名用户时：

如果成功移除 1 个或以上的用户，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。

如果所有用户都没被成功移除，Code 会返回相关返回码，具体请参考全局返回码。

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

Message string

请求结果的说明信息。

RequestId string

请求 ID。

ErrorList object[]

失败列表。

Code 为 0：
ErrorList 为空，全部指定用户移除成功。
ErrorList 不为空，表示部分指定用户移除失败，请参考 SubCode 处理。
Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示全部指定用户移除失败。

Array[

UserId string

移除失败的用户 ID。

SubCode number

移除失败的错误码，完整返回码请参考 Code 说明或者全局返回码。

]

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

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

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

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