移除参会人

将参会人从会议中移除。

请求

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

请求头

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

路径参数

名称	类型	描述
meeting_id	string	会议ID 示例值："6911188411932033028"

查询参数

名称	类型	必填	描述
user_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？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
kickout_users	meeting_user\[\]	是	需移除的用户列表
└ id	string	否	用户ID 示例值："ou_3ec3f6a28a0d08c45d895276e8e5e19b"
└ user_type	int	否	用户类型 示例值：1 可选值有： - 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户

请求体示例

{
    "kickout_users": [
        {
            "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
            "user_type": 1
        }
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ kickout_results	meeting_participant_result\[\]	移除结果
└ id	string	用户ID
└ user_type	int	用户类型 可选值有： - 1: lark用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户
└ result	int	移除结果 可选值有： - 1: 移除成功 - 2: 移除失败

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "kickout_results": [
            {
                "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
                "user_type": 1,
                "result": 1
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	121001	internal error	服务器内部错误，如果重试无效可联系管理员
400	121002	not support	暂不支持该功能
400	121003	param error	参数错误，检查参数的取值范围（请按照上面字段说明自查）
403	121005	no permission	无权限进行该操作，建议检查token类型、操作者身份以及资源的归属
400	122001	meeting status unexpected	会议状态不正确（例如：会中操作而会议不在进行中状态）
404	122002	meeting not exist	所操作的会议不存在
400	122003	operator user not in meeting	进行会中操作的用户必须在会中
400	122005	cannot operate self	用户进行会中操作时，操作对象不能是自己