创建请假日程

调用该接口为指定用户创建一个请假日程。请假日程分为普通日程和全天日程。创建请假日程后，在请假时间内，用户个人签名页会展示请假信息。

Tip: 使用应用身份调用该接口，需要确保应用开启了机器人能力。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/calendar/v4/timeoff_events
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	calendar:time_off:create 创建请假日程 calendar:timeoff 创建或删除请假日程
字段权限要求	> 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"

查询参数

名称	类型	必填	描述
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_id	string	是	用户 ID。ID 类型需要与 user_id_type 的值保持一致。关于用户 ID 可参见用户相关的 ID 概念。 示例值："ou_XXXXXXXXXX"
timezone	string	是	时区信息。 示例值："Asia/Shanghai"
start_time	string	是	请假开始时间。支持以下任一格式： - 秒级时间戳：通过时间戳设置的请假日程为普通日程，即按小时请假。取值示例 1609430400 - 日期格式：通过日期设置的请假日程为全天日程。取值示例 2021-01-01 注意：start_time 和 end_time 所选用的时间格式必须保持一致，否则无效。 示例值："2021-01-01"
end_time	string	是	请假结束时间。支持以下任一格式： - 秒级时间戳：通过时间戳设置的请假日程为普通日程，即按小时请假。取值示例 1609430400 - 日期格式：通过日期设置的请假日程为全天日程。取值示例 2021-01-01 注意：start_time 和 end_time 所选用的时间格式必须保持一致，否则无效。 示例值："2021-01-01"
title	string	否	自定义请假日程标题。 默认值：空，使用默认标题 示例值："请假中(全天) / 1-Day Time Off"
description	string	否	自定义请假日程描述。 默认值：空，使用默认描述 示例值："若删除此日程，飞书中相应的“请假”标签将自动消失，而请假系统中的休假申请不会被撤销。"

请求体示例

{
    "user_id": "ou_XXXXXXXXXX",
    "timezone": "Asia/Shanghai",
    "start_time": "2021-01-01",
    "end_time": "2021-01-01",
    "title": "请假中(全天) / 1-Day Time Off",
    "description": "若删除此日程，飞书中相应的“请假”标签将自动消失，而请假系统中的休假申请不会被撤销。"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	timeoff_event	-
└ timeoff_event_id	string	请假日程 ID。后续可以使用该 ID 删除请假日程。
└ user_id	string	用户 ID。关于用户 ID 可参见用户相关的 ID 概念。
└ timezone	string	时区信息。
└ start_time	string	请假开始时间。可能返回的时间格式： - 秒级时间戳，例如 1609430400 - 日期，例如 2021-01-01
└ end_time	string	请假结束时间。可能返回的时间格式： - 秒级时间戳，例如 1609430400 - 日期，例如 2021-01-01
└ title	string	请假日程标题。
└ description	string	请假日程描述。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "timeoff_event_id": "timeoff:XXXXXX-XXXX-0917-1623-aa493d591a39-XXXXXX",
        "user_id": "ou_XXXXXXXXXX",
        "timezone": "Asia/Shanghai",
        "start_time": "2021-01-01",
        "end_time": "2021-01-01",
        "title": "请假中(全天) / 1-Day Time Off",
        "description": "若删除此日程，飞书中相应的“请假”标签将自动消失，而请假系统中的休假申请不会被撤销。"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	190002	invalid parameters in request	无效的请求参数。排查建议如下： - 确认请求参数的字段名称、传参类型正确。 - 确认已经申请了相应资源的权限。 - 确认相应资源未被删除。
500	190003	internal service error	内部服务错误，请咨询技术支持。
429	190004	method rate limited	方法频率限制。建议稍后再试，并适当减小请求 QPS。
429	190005	app rate limited	应用频率限制。建议稍后再试，并适当减小请求 QPS。
403	190006	wrong unit for app tenant	请求错误，检查应用 App ID 和 App Secret 是否正确。如仍无法解决请咨询技术支持。
404	190007	app bot_id not found	应用的 bot_id 没有找到。你需要确保应用开启了机器人能力。如仍未解决请咨询技术支持。
429	190010	current operation rate limited	当前操作被限流，原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率，然后重试。
403	190011	tenant encrypt key has been deleted	加解密状态的自主密钥被删除，被该秘钥加密的数据不可用。
403	190012	tenant decrypt key has been deleted	仅解密状态的自主密钥被删除，被该秘钥加密的数据不可用。
404	195100	user is dismiss or not exist in the tenant	当前身份或指定用户已经离职，或者不在该租户内。请检查并改为正确的身份来调用接口。

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