创建共享日历

调用该接口为当前身份（应用或用户）创建一个共享日历。

Tip: - 当前身份由 Header Authorization 的 Token 类型决定。tenant_access_token 指应用身份，user_access_token 指用户身份。

• 如果使用应用身份调用该接口，则需要确保应用开启了机器人能力。
• 调用该接口创建共享日历时，当前身份会自动订阅该日历。单个身份可订阅的日历数量上限为 1000。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/calendar/v4/calendars
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	calendar:calendar 更新日历及日程信息 calendar:calendar:create 创建日历

请求头

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

请求体

名称	类型	必填	描述
summary	string	否	日历标题。 默认值：空 示例值："测试日历" 数据校验规则： - 最大长度：255 字符
description	string	否	日历描述。 默认值：空 示例值："使用开放接口创建日历" 数据校验规则： - 最大长度：255 字符
permissions	string	否	日历公开范围。 默认值：show_only_free_busy 示例值："private" 可选值有： - private: 私密 - show_only_free_busy: 仅展示忙闲信息 - public: 公开，他人可查看日程详情
color	int	否	日历颜色，取值通过颜色 RGB 值的 int32 表示，其中，24 ~ 31 位为透明度，16 ~ 23 位为红，8 ~ 15 位为绿，0 ~ 7 位为蓝。例如，-11034625 表示 RGB 值 (87, 159, 255)。 注意： - 取值范围为 -2^31 ~ 2^31-1 - 日历颜色会映射到飞书客户端色板上最接近的一种颜色进行展示。 - 该颜色仅对当前身份生效。 默认值：-14513409 示例值：-1
summary_alias	string	否	日历备注名，设置该字段后（包括后续修改该字段）仅对当前身份生效。 默认值：空 示例值："日历备注名" 数据校验规则： - 最大长度：255 字符

请求体示例

{
    "summary": "测试日历",
    "description": "使用开放接口创建日历",
    "permissions": "private",
    "color": -1,
    "summary_alias": "日历备注名"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ calendar	calendar	新创建的日历实体信息。
└ calendar_id	string	日历 ID。后续可以通过该 ID 查询、更新或删除日历信息。更多信息可参见日历 ID 字段说明。
└ summary	string	日历标题。
└ description	string	日历描述。
└ permissions	string	日历公开范围。 可选值有： - private: 私密 - show_only_free_busy: 仅展示忙闲信息 - public: 公开，他人可查看日程详情
└ color	int	日历颜色，由颜色 RGB 值的 int32 表示。实际在客户端展示时会映射到色板上最接近的一种颜色，且该字段仅对当前身份生效。
└ type	string	日历类型。 可选值有： - unknown: 未知类型 - primary: 用户或应用的主日历 - shared: 由用户或应用创建的共享日历 - google: 用户绑定的谷歌日历 - resource: 会议室日历 - exchange: 用户绑定的 Exchange 日历
└ summary_alias	string	日历备注名，仅对当前身份生效。
└ is_deleted	boolean	对于当前身份，日历是否已经被标记为删除。
└ is_third_party	boolean	当前日历是否是第三方数据。三方日历及日程只支持读，不支持写入。
└ role	string	当前身份对于该日历的访问权限。 可选值有： - unknown: 未知权限 - free_busy_reader: 游客，只能看到忙碌、空闲信息 - reader: 订阅者，可查看所有日程详情 - writer: 编辑者，可创建及修改日程 - owner: 管理员，可管理日历及共享设置

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "calendar": {
            "calendar_id": "feishu.cn_xxxxxxxxxx@group.calendar.feishu.cn",
            "summary": "测试日历",
            "description": "使用开放接口创建日历",
            "permissions": "private",
            "color": -1,
            "type": "shared",
            "summary_alias": "日历备注名",
            "is_deleted": false,
            "is_third_party": false,
            "role": "owner"
        }
    }
}

错误码

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	当前操作被限流，原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率，然后重试。
404	195100	user is dismiss or not exist in the tenant	当前身份或指定用户已经离职，或者不在该租户内。请检查并改为正确的身份来调用接口。

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