飞书开放平台 Server API 文档

主题

获取重复日程实例 ​

调用该接口以当前身份（应用或用户）获取指定日历中的某一重复日程信息。

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

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/calendar/v4/calendars/:calendar_id/events/:event_id/instances
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可calendar:calendar 更新日历及日程信息 calendar:calendar.event:read 读取日程信息 calendar:calendar:readonly 获取日历、日程及忙闲信息

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数 ​

名称类型描述
calendar_idstring日历 ID。关于日历 ID 可参见日历 ID 说明。
示例值："feishu.cn_HF9U2MbibE8PPpjro6xjqa@group.calendar.feishu.cn"
event_idstring日程 ID。
创建日程时会返回日程 ID。你也可以调用以下接口获取某一日历的 ID。 - 获取日程列表 - 搜索日程
示例值："75d28f9b-e35c-4230-8a83-4a661497db54_0"

查询参数 ​

名称类型必填描述
start_timestring是开始时间，Unix 时间戳，单位为秒。该参数与 end_time 用于设置时间范围，即重复日程的查询区间为 （start_time, end_time）
注意：start_time 与 end_time 之间的时间区间不能超过 2年。
示例值：1631777271
end_timestring是结束时间，Unix 时间戳，单位为秒。该参数与 start_time 用于设置时间范围，即重复日程的查询区间为 （start_time, end_time）
注意：start_time 与 end_time 之间的时间区间不能超过 2年。
示例值：1631777271
page_sizeint否一次调用返回的日程数量上限。
示例值：10
默认值：50
数据校验规则：
- 取值范围：10 ～ 500
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ itemsinstance\[\]重复日程的日程 instance 列表。
    └ event_idstring日程实例 ID。
注意：重复日程实例的 ID 与其他日程 ID 不同，其 ID 包含了实例原始时间（Original time），数据格式为秒级时间戳。例如：2cf525f0-1e67-4b04-ad4d-30b7f003903c_1713168000，其中 1713168000 即为实例原始时间。
    └ summarystring日程主题。
    └ descriptionstring日程描述。
    └ start_timetime_info日程开始时间。
      └ datestring开始时间，仅全天日程使用该字段，RFC 3339 格式，例如，2018-09-01。
      └ timestampstring秒级时间戳，指日程具体的开始时间。例如，1602504000 表示 2020/10/12 20:00:00（UTC +8 时区）。
      └ timezonestring时区。使用 IANA Time Zone Database 标准。
    └ end_timetime_info日程结束时间。
      └ datestring结束时间，仅全天日程使用该字段，RFC 3339 格式，例如，2018-09-01。
      └ timestampstring秒级时间戳，指日程具体的结束时间。例如，1602504000 表示 2020/10/12 20:00:00（UTC +8 时区）。
      └ timezonestring时区。使用 IANA Time Zone Database 标准。
    └ statusstring日程状态。
可选值有：
- tentative: 未回应 - confirmed: 已确认 - cancelled: 日程已取消
    └ is_exceptionboolean日程是否是重复日程的例外日程。了解例外日程，可参见例外日程。
    └ app_linkstring日程的 app_link，用于跳转到具体的某个日程。
    └ locationevent_location日程地点。
      └ namestring地点名称。
      └ addressstring地点地址。
      └ latitudenumber(float)地点坐标纬度信息。 - 对于国内的地点，采用 GCJ-02 标准 - 对于海外的地点，采用 WGS84 标准
      └ longitudenumber(float)地点坐标经度信息。 - 对于国内的地点，采用 GCJ-02 标准 - 对于海外的地点，采用 WGS84 标准
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "event_id": "75d28f9b-e35c-4230-8a83-4a661497db54_1602504000",
                "summary": "日程主题",
                "description": "desc",
                "start_time": {
                    "date": "2018-09-01",
                    "timestamp": "1602504000",
                    "timezone": "Asia/Shanghai"
                },
                "end_time": {
                    "date": "2018-09-01",
                    "timestamp": "1602504400",
                    "timezone": "Asia/Shanghai"
                },
                "status": "confirmed",
                "is_exception": false,
                "app_link": "https://applink.larkoffice.com/client/calendar/event/detail?calendarId=7039673579105026066&key=aeac9c56-aeb1-4179-a21b-02f278f59048&originalTime=0&startTime=1700496000",
                "location": {
                    "name": "上海",
                    "address": "徐汇区",
                    "latitude": 23.4444,
                    "longitude": 23.4444
                }
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
400190002invalid parameters in request无效的请求参数。排查建议如下： - 确认请求参数的字段名称、传参类型正确。 - 确认已经申请了相应资源的权限。 - 确认相应资源未被删除。
500190003internal service error内部服务错误，请咨询技术支持。
429190004method rate limited方法频率限制。建议稍后再试，并适当减小请求 QPS。
429190005app rate limited应用频率限制。建议稍后再试，并适当减小请求 QPS。
403190006wrong unit for app tenant请求错误，检查应用 App ID 和 App Secret 是否正确。如仍无法解决请咨询技术支持。
404190007app bot_id not found应用的 bot_id 没有找到。你需要确保应用开启了机器人能力。如仍未解决请咨询技术支持。
400190008page_token or sync_token expiredpage_token或者sync_token已过期，请置空token再重试
429190010current operation rate limited当前操作被限流，原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率，然后重试。
403190011tenant encrypt key has been deleted加解密状态的自主密钥被删除，被该秘钥加密的数据不可用。
403190012tenant decrypt key has been deleted仅解密状态的自主密钥被删除，被该秘钥加密的数据不可用。
404191000calendar not found日历没有找到。你需要检查并改为正确的日历 ID。
400191001invalid calendar_idcalendar_id 无效。你需要检查并改为正确的日历 ID。
403191002no calendar access_role当前身份没有日历的访问权限。如需查询某一日历信息，则需要确保当前身份拥有该日历的访问权限。
403191003calendar is deleted日历已经被删除。你需要检查并改为正确的日历 ID。
403191004invalid calendar type日历类型错误。你可以调用查询日历信息接口获取日历类型信息，然后确保日历类型适用于当前接口。
400193000invalid event_idevent_id 无效。你需要检查并改为正确的日程 ID。
404193001event not found日程未找到。你需要确保传入了正确的日程 ID。
403193002no permission to operate event无权限操作。你需要确保有日历以及日程的编辑权限。
403193003event is deleted日程已经被删除。你需要检查并改为正确的日程 ID。
404195100user is dismiss or not exist in the tenant当前身份或指定用户已经离职，或者不在该租户内。请检查并改为正确的身份来调用接口。

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

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有