移除群成员 | OpenIM Docs

跳到主要内容

移除群成员

简要描述

将用户从群组中移除。不能移除群主，如果移除群主，先转让群主身份。

请求方式

post

请求URL

{API_ADDRESS}/group/kick_group

header名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	用于全局链路追踪，建议使用时间戳，在每个请求中独立
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
  "groupID": "2137448827",
  "kickedUserIDs": [
    "2137448827"
  ],
  "reason": "nihao"
}

字段名	选填	类型	说明
groupID	必填	string	群ID
kickedUserIDs	必填	array	被移除群的用户ID列表
reason	选填	string	被移除群的原因

成功返回示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，0表示成功
errMsg	string	错误简要信息，为空
errDlt	errDlt	错误详细信息，为空
data	object	通用数据对象，具体结构见下方

失败返回示例

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息

移除群成员