批量关闭系统状态

批量关闭用户系统状态可用。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/personal_settings/v1/system_statuses/:system_status_id/batch_close
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	personal_settings:status:system_status_operate 开启或关闭用户系统状态
字段权限要求	> 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"

路径参数

名称	类型	描述
system_status_id	string	系统状态ID 获取系统状态ID 示例值："7101214603622940671"

查询参数

名称	类型	必填	描述
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

请求体

名称	类型	必填	描述
user_list	string\[\]	是	用户ID列表，传入的ID类型由user_id_type决定，推荐使用 OpenID，获取方式可参考文档如何获取 Open ID。 示例值：["ou_53edd3282dbc2fdbe5c593cfa5ce82ab"] 数据校验规则： - 长度范围：1 ～ 50

请求体示例

{
    "user_list": [
        "ou_53edd3282dbc2fdbe5c593cfa5ce82ab"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ result_list	system_status_user_close_result_entity\[\]	关闭结果
└ user_id	string	用户ID
└ result	string	关闭结果 可选值有： - success: 成功 - fail: 失败 - invisible_user_id: 用户ID不可见 - invalid_user_id: 用户ID无效 - resign_user_id: 用户离职

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "result_list": [
            {
                "user_id": "ou_53edd3282dbc2fdbe5c593cfa5ce82ab",
                "result": "success"
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	2005001	Your request contains an invalid request parameter.	参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400	2005006	Request contains other tenant user.	请检查用户ID是否为本租户ID。
400	2005007	Tenant does not have permission to api.	租户没有访问api权限。