将用户或机器人移出群聊

DELETE

/open-apis/im/v1/chats/{chat_id}/members

自建应用商店应用

将用户或机器人移出群聊。

注意事项：

应用需要开启机器人能力

用户或机器人在任何条件下均可移除自己出群（即主动退群）

仅有群主/管理员或创建群组并且具备更新应用所创建群的群信息权限的机器人，可以移除其他用户或者机器人

每次请求，最多移除50个用户或者5个机器人

操作内部群时，操作者须与群组在同一租户下

错误码

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是否正确。
400	232007	Your request specifies a chat_id or user_id which is invalid.	无效的 chat_id 或者 user_id。
400	232010	Operator and chat can NOT be in different tenants.	操作者和被操作的群组应该在同一租户下。
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.	加入群聊的成员为空或不存在有效的成员。
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.	群主不能被踢出群。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://open.feishu.cn/open-apis/im/v1/chats/oc_a0553eda9014c201e6969b478895c230/members' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_list": [
        "ou_9204a37300b3700d61effaa439f34295"
    ]
}'

响应示例

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

请求参数

Path 参数

chat_id

必需

群 ID，详情参见群ID 说明注意：仅支持群模式为group、topic的群组ID 示例值："oc_a0553eda9014c201e6969b478895c230"

示例值:

oc_a0553eda9014c201e6969b478895c230

Query 参数

member_id_type

可选

出群成员ID类型注意：移除机器人请使用 app_id 示例值："open_id" 可选值有： user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID？ app_id：飞书开放平台应用的唯一标识。在创建应用时，由系统自动生成，用户不能自行修改。了解更多：如何获取应用的 App ID？默认值：open_id

示例值:

open_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

id_list

array[string]

可选

成员列表。移除群内的用户时推荐使用 OpenID，获取方式可参考文档如何获取 Open ID？；移除群内的机器人时需填写应用的App ID，请参考如何获取应用的 App ID？注意：成员列表不可为空列表中填写的成员ID类型应与 member_id_type 参数中选择的类型相对应示例值：["ou_9204a37300b3700d61effaa439f34295"]

示例