批量移除用户组成员

POST

https://open.feishu.cn/open-apis/contact/v3/group/{group_id}/member/batch_remove

从普通用户组中批量移除成员 (目前仅支持移除用户，暂不支持移除部门）。如果应用的通讯录权限范围是“全部员工”，则可将任何成员移出任何用户组。如果应用的通讯录权限范围不是“全部员工”，则仅可将通讯录权限范围中的成员从通讯录权限范围的用户组中移除，点击了解通讯录权限范围。

请求体中的member_type，目前仅支持user，未来将支持department。

错误码

HTTP状态码	错误码	描述	排查建议
400	40001	param error	参数错误。
500	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
400	40022	invalid member_id_type	成员ID类型无效
400	41073	invalid member_id	成员ID 无效
400	41074	invalid member_type	无效的成员类型
400	42002	invalid group_id	用户组 ID 无效
403	42009	no group authority	缺少用户组权限。应用的通讯录权限范围需包含该用户组或为“全部员工”，点击了解更多
403	41050	no user authority error	操作的用户需在通讯录权限范围中，了解更多

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/contact/v3/group//member/batch_remove' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "members": [
        {
            "member_id": "u287xj12",
            "member_type": "user",
            "member_id_type": "user_id"
        }
    ]
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

请求参数

Path 参数

group_id

string

必需

用户组ID 示例值："test_group"

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

members

array [object {3}]

必需

待移除成员数据校验规则：长度范围：1 ～ 100

member_id

string

可选

成员ID 示例值："u287xj12"

member_type

string

可选

用户组成员的类型，取值为 user或department。示例值："user"

member_id_type

string

可选

当member_type为user时，member_id_type表示user_id_type，可选值为open_id, union_id, user_id。仅在请求参数中有效，响应体中不会返回此参数。示例值："user_id"

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

查询用户组成员列表

概述

批量移除用户组成员

错误码#

请求参数

返回响应

错误码