将用户或机器人移出群聊

将指定的用户或机器人从群聊中移出。

前提条件

调用该接口的应用，需要开启机器人能力。

使用限制

• 仅群主、群管理员，或者是创建群组且具有 更新应用所创建群的群信息（im:chat:operate_as_owner） 权限的机器人，可以将其他群成员移出群组。
• 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。
• 每次请求，最多移除 50 个用户或者 5 个机器人。
• 操作内部群时，操作者须与群组在同一租户下。
• 操作同一个群组时，如果同时多次调用当前接口，可能会出现 232019 错误码，建议你串行调用，即等待当前调用完成后再进行下一次调用。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/:chat_id/members
HTTP Method	DELETE
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat.members:write_only 添加、移除群成员
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
chat_id	string	群 ID。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 注意：仅支持群模式为 群组（group）、话题（topic） 的群组 ID。你可以调用获取群信息接口，在返回结果中查看 chat_mode 参数取值是否为 group、topic。 示例值："oc_a0553eda9014c201e6969b478895c230"

查询参数

名称	类型	必填	描述
member_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID？ - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ - app_id: 飞书开放平台应用的唯一标识。在创建应用时，由系统自动生成，用户不能自行修改。了解更多：如何获取应用的 App ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
id_list	string\[\]	否	成员 ID 列表。ID 类型与查询参数 member_id_type 的取值一致。 - 移除群内的用户时推荐使用 OpenID，获取方式可参考文档如何获取 Open ID？。 - 移除群内的机器人时需填写应用的 App ID，请参考如何获取应用的 App ID？。 注意： - 成员列表不可为空。 - 每次请求，最多移除 50 个用户或者 5 个机器人。 示例值：["4d7a3c6g"]

请求体示例

{
    "id_list": [
        "4d7a3c6g"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ invalid_id_list	string\[\]	无效成员列表。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "invalid_id_list": [
            "4d7a3c6g"
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误，参考接口文档提供的参数描述，检查输入参数是否有误。
400	232004	Such an app does NOT exist.	作为操作者的 app_id 不存在，请联系技术支持。
400	232006	Your request specifies a chat_id which is invalid.	无效的 chat_id，请检查 chat_id 是否正确。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
400	232007	Your request specifies a chat_id or user_id which is invalid.	无效的 chat_id 或者 user_id。请检查传入的参数是否正确。
400	232009	Your request specifies a chat which has already been dissolved.	群组已被解散，无法操作。
400	232010	Operator and chat can NOT be in different tenants.	调用接口的操作者和被操作的群组不在同一租户下，无法操作。需确保当前的操作者和被操作的群组在同一租户下。
400	232011	Operator can NOT be out of the chat.	操作者不在该群中，无法操作。
400	232014	The token used in the request does NOT have the permissions necessary to complete the request.	操作者没有权限进行该操作，请检查是否已开通调用接口所需要的权限。
400	232019	The request has been rate limited.	触发群限流，请控制请求的速度，详情参见频控策略。 说明：调用将用户或机器人拉入群聊和将用户或机器人移出群聊接口操作同一个群组时，如果同时多次调用接口，可能会出现当前报错，建议你串行调用，即等待当前调用完成后再进行下一次调用。
400	232025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	232027	There are no valid members in the ID list specified in your request.	成员 ID 列表为空或不存在有效的成员。
400	232029	There are no available candidates for chat owner.	没有可用的候选群主。
400	232033	The operator or invited bots does NOT have the authority to manage external chats without the scope.	没有权限操作外部群。
400	232034	The app is unavailable or inactivated by the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。
400	232076	Can't kick chat owner.	群主不能被踢出群。

更多错误码信息，参见通用错误码。