资源介绍

资源定义

日程是一个与特定日期或时间段关联的实体，存在于日历上。日程有一些属性，如：日程的主题、开始及结束时间、日程描述、地点、提醒时间、参与者等。

字段说明

名称	类型	描述
event_id	string	日程实体的唯一标志。只读字段示例值："efa67a98-06a8-4df5-8559-746c8f4477ef_0" 获取方式：获取日程列表搜索日程创建日程
organizer_calendar_id	string	日程组织者的 `calendar_id` 关于 `calendar_id`，可参考日历资源概述关于日程组织者，可参考本文下方「日程组织者」章节只读字段示例值："feishu.cn_ZefWrFi6e12ds@group.calendar.feishu.cn"
summary	string	日程标题示例值："Daily Meeting" 数据校验规则：最大长度：`1000` 字符
description	string	日程描述示例值："Discuss today's work schedule." 数据校验规则：最大长度：`40960` 字符
start_time	time_info	日程开始时间的相关信息，对于重复日程，表示重复日程第一次实例的开始时间
∟date	string	全天日程的开始日期。与 `timestamp` 字段互斥，当此字段有值时，表示当前日程是全天日程。示例值："2018-09-01" 数据校验规则：格式要求：需满足 RFC3339 中的 `date` 格式
∟timestamp	string	日程开始时间的时间戳。例如，"1602504000" 表示 2020-10-12T12:00:00+00:00。与 `date` 字段互斥示例值："1602504000" 数据校验规则：数据范围：`1` ~ `16725225600`
∟timezone	string	日程开始时间的时区。日程为全天日程时，此字段固定为 "UTC"。示例值："Asia/Shanghai" 默认值："Asia/Shanghai" 数据校验规则：格式要求：需满足 IANA Time Zone Database 中的时区定义
end_time	time_info	日程结束时间的相关信息，对于重复日程，表示重复日程第一次实例的结束时间
∟date	string	全天日程的结束日期。与 `timestamp` 字段互斥，当此字段有值时，表示当前日程是全天日程。示例值："2018-09-01" 数据校验规则：格式要求：需满足 RFC3339 中的 `date` 格式
∟timestamp	string	日程结束时间的时间戳。例如，"1602504000" 表示 2020-10-12T12:00:00+00:00。与 `date` 字段互斥示例值："1602504000" 数据校验规则：数据范围：`1` ~ `16725225600`
∟timezone	string	日程结束时间的时区。日程为全天日程时，此字段固定为 "UTC"。示例值："Asia/Shanghai" 默认值："Asia/Shanghai" 数据校验规则：格式要求：需满足 IANA Time Zone Database 中的时区定义
vchat	vchat	日程绑定的视频会议信息
∟vc_type	string	视频会议类型可选值有：`vc` 飞书视频会议`third_party` 第三方会议链接`no_meeting` 无视频会议`lark_live` 飞书直播，该类型视频会议只能由飞书系统生成示例值："vc"
∟meeting_url	string	视频会议参会链接当 `vc_type` 类型为 `vc`, `lark_live` 时，仅支持读取当 `vc_type` 类型为 `third_party` 时，支持写入与读取示例值："https://example.com" 数据校验规则：长度范围：`1` ~ `2000` 字符
∟icon_type	string	当 `vc_type` 为 `third_party` 时，该字段定义飞书客户端展示的视频会议 Icon 类型。可选值有：`vc` 飞书视频会议 Icon`live` 飞书直播 Icon`default` 默认类型 Icon示例值："vc"
∟description	string	当 `vc_type` 为 `third_party` 时，该字段定义飞书客户端展示的视频会议提醒文案。示例值："发起视频会议" 数据校验规则：最大长度：`500` 字符
visibility	string	日程详情公开范围可选值有：`default` 订阅该日程所在日历的用户，如果有权查看该日历中其他日程的详情，那么就能看到此日程的详情`public` 订阅该日程所在日历的用户，都能查看此日程详情`private` 订阅该日程所在日历的用户，无法查看此日程的详情，除非他们拥有该日历 `writer` 或 `owner` 级别的 Acl。关于 Acl，请参考用户访问控制 Acl 资源概述示例值："default"
attendee_ability	string	日程参与人权限可选值有：`none` 日程参与人无法编辑日程、无法邀请其它参与人、无法查看参与人列表`can_see_others` 日程参与人无法编辑日程、无法邀请其它参与人、可以查看参与人列表`can_invite_others` 日程参与人无法编辑日程、可以邀请其它参与人、可以查看参与人列表`can_modify_event`日程参与人可以编辑日程、可以邀请其它参与人、可以查看参与人列表示例值："can_invite_others" 默认值："can_invite_others"
status	string	日程状态只读字段可选值有：`tentative` 日程暂未回应`confirmed` 日程已确认`cancelled` 日程已删除，当该日程是例外日程时，需要额外处理，可参考本文下方「重复日程」章节示例值："confirmed"
free_busy_status	string	当前身份下，日程所在日历上对应时间段的忙闲状态，可参考查询忙闲可选值有：`busy` 该日程对应的时间段在日历忙闲上标记为忙碌`free` 该日程对应的时间段在日历忙闲上标记为空闲示例值："busy" 默认值："busy" 当前身份：由请求 API 时的鉴权方式决定，详细说明参见API访问凭证概述
location	event_location	日程地点信息
∟name	string	地点名称示例值："东方明珠" 数据校验规则：长度范围：`1` ~ `512` 字符
∟address	string	地点地址示例值：”普通市和平区世纪大道1号“ 数据校验规则：长度范围：`1` ~ `255` 字符
∟latitude	float	地点坐标纬度信息。国内地点采用 GCJ-02 标准，海外地点采用 WGS84 标准示例值：31.239702224731445
∟longitude	float	地点坐标经度信息。国内地点采用 GCJ-02 标准，海外地点采用 WGS84 标准示例值：121.49971771240234
color	int	当前身份下，日程颜色 RGB 值的 int32 表示。例如，-11034625 表示 RGB 值 (87, 159, 255) 飞书客户端展示日程颜色时，会将该值映射到预设色板上最相近的颜色当日程颜色值为 0 或 -1 时，日程颜色展示将跟随日历颜色关于日历颜色，可参考日历资源概述示例值：-11034625 当前身份：由请求 API 时的鉴权方式决定，详细说明参见API访问凭证概述
reminders	reminder[]	当前身份下，该日程的提醒列表当前身份：由请求 API 时的鉴权方式决定，详细说明参见API访问凭证概述
∟minutes	int	日程提醒时间的偏移量。例如，5 表示在日程开始前 5 分钟提醒，-5 表示在日程开始后 5 分钟示例值：5 数据校验规则：数据范围：`-20160` ~ `20160`
recurrence	string	重复日程的重复性规则，使用 RFC5545 中的 `RRULE` 定义。非重复日程或例外日程的该字段为空关于重复日程和例外日程，可参考本文下方「重复日程」章节示例值：“FREQ=DAILY;COUNT=10” 数据校验规则：最大长度：`2000` 字符格式要求：满足 RFC5545 中的 `RRULE` 定义；且 `COUNT` 和 `UNTIL` 不能同时出现
is_exception	boolean	该日程是否是一个重复日程的例外日程关于重复日程和例外日程，可参考本文下方「重复日程」章节只读字段示例值：true
recurring_event_id	string	当 `is_exception` 为 true 时有效，表示该例外日程关联的重复日程的 `event_id` 关于重复日程和例外日程，可参考本文下方「重复日程」章节只读字段示例值："f9b7f399-14d1-4614-a5b1-306295995d8f_0"
schemas	schema[]	用于控制飞书客户端日程详情页部分 UI 的自定义信息
∟ui_name	string	UI 名称，唯一标志一个飞书客户端日程详情页按钮或区域可选值有：`ForwardIcon` 日程转发按钮`MeetingChatIcon` 会议群聊按钮`MeetingMinutesIcon` 会议纪要按钮`MeetingVideo` 视频会议区域`RSVP` 接受/拒绝/待定区域`Attendee` 参与者区域`OrganizerOrCreator` 组织者/创建者区域示例值："ForwardIcon"
∟ui_status	string	UI 自定义状态可选值有：`hide` 隐藏显示示例值："hide"
∟app_link	string	当 `ui_name` 对应的 UI 为按钮时，该字段指定点击后跳转的链接只读字段

数据示例

{
    "event_id": "07e1c96d-c59a-4987-98a7-ed7938c32b70_0",
    "organizer_calendar_id": "feishu.cn_9c6UTwO7wkkY3F35l7wvxa@group.calendar.feishu.cn",
    "summary": "Daily Meeting",
    "description": "Discuss today's work schedule.",
    "start_time": {
        "timestamp": "1654041600",
        "timezone": "Asia/Shanghai"
    },
    "end_time": {
        "timestamp": "1654059600",
        "timezone": "Asia/Shanghai"
    },
    "vchat": {
        "description": "Example Third Party Vchat",
        "icon_type": "vc",
        "meeting_url": "https://example.com",
        "vc_type": "third_party"
    },
    "visibility": "default",
    "attendee_ability": "can_invite_others",
    "status": "confirmed",
    "free_busy_status": "busy",
    "location": {
        "address": "普通市和平区世纪大道1号",
        "latitude": 31.239702224731445,
        "longitude": 121.49971771240234,
        "name": "东方明珠"
    },
    "color": -1,
    "reminders": [
        {
            "minutes": 30
        }
    ],
    "recurrence": "",
    "is_exception": false
}

日程组织者

每个日程都有组织者，表示日程创建时所在的日历。

例如，应用使用 tenant_access_token 在主日历上创建了日程，那日程的组织者是应用的主日历；应用使用某用户的 user_access_token 在主日历上创建了日程，那日程的组织者是用户的主日历；如果日程被创建在共享日历上，那共享日历便是日程组织者。

日程组织者和对组织者日历有权限的所有用户，对日程有完整权限。

重复日程

重复日程会按指定的重复性规则发生多次，产生多个实例，例如周会、日会等，这些日程实例通常具有相同的标题、描述、参与人等。

重复性规则

重复日程的时间由两部分数据来定义：

日程的 start 和 end 字段，定义重复日程每一次重复时的时间

日程的 recurrence 字段，定义重复日程的规则

日程的 recurrence 字段使用 RFC5545 中的 RRULE 定义，RRULE 一般由以下几个部分组成：

FREQ - 日程重复的频率。例如 DAILY 或 WEEKLY。必填

INTERVAL - 与 FREQ 配合，细化频率信息。例如 FREQ=DAILY;INTERVAL=2 表示每两天重复一次

COUNT - 日程重复的次数

COUNT 和 UNTIL 不能同时出现在 RRULE 中

UNTIL - 日程重复的最后时间

BYDAY - 日程重复的特定日期，例如 FREQ=WEEKLY;BYDAY=MO 表示每周一重复

例外日程

重复日程由多个不同时间的实例组成，当某个实例的信息被修改，与重复日程产生区别后，该实例被称为例外日程。

例外日程可能有不同的标题、描述、开始时间、参与人等，例外日程也可以被单独删除。

当例外日程的 status 为 cancelled 时，表明该重复日程的此次实例被取消，不应该再展示给用户。应用应该把 status 为 cancelled 的例外日程与关联的重复日程绑定，避免产生错误的展示信息。

资源定义#

字段说明#

数据示例#

日程组织者#

重复日程#

重复性规则#

例外日程#