飞书开放平台 Server API 文档

主题

获取日程参与人列表 ​

调用该接口以当前身份（应用或用户）获取日程的参与人列表。

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

  • 如果使用应用身份调用该接口，则需要确保应用开启了机器人能力。
  • 当前身份必须对日历有 reader、writer 或 owner 权限。你可以调用查询日历信息接口，获取当前身份对该日历的访问权限（role）。
  • 当前身份必须有权限查看日程的参与人列表，即当前身份需要是日程的组织者，或者是日程参与人且日程设置了参与人可查看参与人列表权限。你可以调用获取日程接口，获取日程的参与人权限（attendee_ability）。
  • 如果你需要获取群组类型参与人的群成员，需要调用获取参与人群成员列表接口。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/calendar/v4/calendars/:calendar_id/events/:event_id/attendees
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可calendar:calendar 更新日历及日程信息 calendar:calendar.event:read 读取日程信息 calendar:calendar:readonly 获取日历、日程及忙闲信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头 ​

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

路径参数 ​

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

查询参数 ​

名称类型必填描述
user_id_typestring否用户 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
need_resource_customizationboolean否是否需要会议室表单信息。
可选值有： - true：需要 - false（默认值）：不需要
注意：当前身份需要有日程的编辑权限才会返回会议室表单信息，即当前身份需要是日程的组织者，或者是日程参与人且日程设置了参与人可编辑日程权限。你可以调用获取日程接口，获取日程的参与人权限（attendee_ability）。
示例值：true
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：780TRhwXXXXX
page_sizeint否一次请求返回的最大日程参与人数量。最小值为 10，传入小于 10 的值默认按照 10 计算。
示例值：10
默认值：20
数据校验规则：
- 最大值：100

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ itemscalendar.event.attendee\[\]日程参与人列表。
    └ typestring参与人类型。
可选值有：
- user: 用户 - chat: 群组 - resource: 会议室 - third_party: 外部邮箱
    └ attendee_idstring参与人 ID。日程参与人在当前日程内的唯一标识，后续可通过该 ID 删除日程参与人，或用于查询群组类型参与人的群成员信息。
    └ rsvp_statusstring参与人 RSVP 状态，即日程回复状态。
可选值有：
- needs_action: 参与人尚未回复状态，或表示会议室预约中 - accept: 参与人回复接受，或表示会议室预约成功 - tentative: 参与人回复待定 - decline: 参与人回复拒绝，或表示会议室预约失败 - removed: 参与人或会议室已经从日程中被移除
    └ is_optionalboolean参与人是否为可选参加，该参数值对群组的群成员不生效。
    └ is_organizerboolean参与人是否为日程组织者。
    └ is_externalboolean参与人是否为外部参与人。外部参与人不支持编辑。
    └ display_namestring参与人名称。
    └ chat_membersattendee_chat_member\[\]群成员信息。
注意：该字段已废弃，如需获取群中的群成员，请使用 获取参与人群成员列表接口。
      └ rsvp_statusstring参与人 RSVP 状态。
可选值有：
- needs_action: 参与人尚未回复状态，或表示会议室预约中 - accept: 参与人回复接受，或表示会议室预约成功 - tentative: 参与人回复待定 - decline: 参与人回复拒绝，或表示会议室预约失败 - removed: 参与人或会议室已经从日程中被移除
      └ is_optionalboolean参与人是否为可选参加。
      └ display_namestring参与人名称。
      └ is_organizerboolean参与人是否为日程组织者。
      └ is_externalboolean参与人是否为外部参与人。
    └ user_idstring用户类型参与人的用户 ID，ID 类型与 user_id_type 的值保持一致。关于用户 ID 可参见用户相关的 ID 概念。
注意：当 is_external 返回为 true 时，此字段只会返回 open_id 或者 union_id。
    └ chat_idstring群组类型参与人的群组 ID。关于群组 ID 可参见群 ID 说明。
    └ room_idstring会议室类型参与人的会议室 ID。
    └ third_party_emailstring外部邮箱类型参与人的邮箱地址。
    └ operate_idstring如果日程是使用应用身份创建的，在添加会议室时，指定的会议室联系人 ID。ID 类型与 user_id_type 的值保持一致。
    └ resource_customizationcalendar.attendee.resource_customization\[\]会议室的个性化配置。
      └ index_keystring每个配置的唯一 ID。
      └ input_contentstring填空类型的取值。
      └ optionscustomization.option\[\]每个配置的选项。
        └ option_keystring每个选项的唯一 ID。
        └ others_contentstring其他选项类型的取值。
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "type": "user",
                "attendee_id": "user_xxxxxx",
                "rsvp_status": "needs_action",
                "is_optional": true,
                "is_organizer": true,
                "is_external": false,
                "display_name": "Zhang San",
                "chat_members": [
                    {
                        "rsvp_status": "needs_action",
                        "is_optional": true,
                        "display_name": "Group",
                        "is_organizer": false,
                        "is_external": false
                    }
                ],
                "user_id": "ou_xxxxxxxx",
                "chat_id": "oc_xxxxxxxxx",
                "room_id": "omm_xxxxxxxx",
                "third_party_email": "wangwu@email.com",
                "operate_id": "ou_xxxxxxxx",
                "resource_customization": [
                    {
                        "index_key": "16281481596100",
                        "input_content": "xxx",
                        "options": [
                            {
                                "option_key": "16281481596185",
                                "others_content": "xxx"
                            }
                        ]
                    }
                ]
            }
        ],
        "has_more": true,
        "page_token": "38RTjheyXXXX"
    }
}

错误码 ​

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。
404194000attendee not found没有找到参与人。你需要确保参与人相关参数填写正确。
403194001no permission to list event attendees无操作权限。检查 calendar_id 是否是当前日程组织者日历，或者组织者是否有查看参与人的权限。
403194002no permission to create event attendees无操作权限。检查 calendar_id 是否是当前日程组织者日历，或者组织者是否有邀请参与人的权限。
403194003no permission to delete event attendees无操作权限。检查 calendar_id 是否是是当前日程组织者日历。
400194004invalid attendee type参与人类型无效。需检查参与人类型是否填写正确。
404195100user is dismiss or not exist in the tenant当前身份或指定用户已经离职，或者不在该租户内。请检查并改为正确的身份来调用接口。

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

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

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