服务端 API/日历/日程参与人管理（含会议室）/添加日程参与人 # 添加日程参与人 调用该接口以当前身份（应用或用户）为指定日程添加一个或多个参与人，参与人类型包括用户、群组、会议室以及邮箱。 **注意事项**：- 当前身份由 Header Authorization 的 Token 类型决定。tenant_access_token 指应用身份，user_access_token 指用户身份。 - 如果使用应用身份调用该接口，则需要确保应用开启了[机器人能力](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。 - 当前身份需要有日历的 writer 或 owner 权限，并且日历的类型只能为 primary 或 shared。你可以调用[查询日历信息](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口，获取日历类型以及当前身份对该日历的访问权限。 - 当前身份需要是日程的组织者，或者是日程参与人且确保日程设置了**参与人可邀请其它参与人**权限。你可以调用[获取日程](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/get)接口，获取日程的参与人权限（attendee_ability）。 - 新添加的日程参与人必须与日程组织者在同一个企业内。 - 每个日程最多只能有 3000 名参与人。 - 使用该接口添加会议室后，会议室会进入异步的预约流程，即请求结束不代表会议室预约成功，需后续再查询会议室的预约状态。 - 开启会议室管理员能力后，管理员预约会议室可不受会议室预约范围的限制（当前不支持用管理员身份给其他成员的日程预约会议室）。 ## 请求 基本 |   ---|--- HTTP URL | https://open.larksuite.com/open-apis/calendar/v4/calendars/:calendar_id/events/:event_id/attendees HTTP Method | POST 接口频率限制 | [1000 次/分钟、50 次/秒](https://open.larksuite.com/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 更新日历及日程信息(calendar:calendar)
更新日程(calendar:calendar.event:update) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" ### 路径参数 名称 | 类型 | 描述 ---|---|--- calendar_id | string | 日程对应的日历 ID。了解更多，参见[日历 ID 说明](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/introduction)。
**示例值**："larksuite.com_xxxxxxxxxx@group.calendar.larksuite.com" event_id | string | 日程 ID。
创建日程时会返回日程 ID。你也可以调用以下接口获取某一日历的 ID。
- [获取日程列表](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/list)
- [搜索日程](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/search)
**示例值**："xxxxxxxxx_0" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- attendees | calendar.event.attendee\[\] | 否 | 新增参与人列表。
**注意**：
- 单次请求可设置的参与人数量（含会议室）上限为 1000。
- 单次请求可设置的会议室数量上限为 100。 type | string | 否 | 参与人类型。
**示例值**："user"
**可选值有**：
- user：用户
- chat：群组
- resource：会议室
- third_party：外部邮箱 is_optional | boolean | 否 | 参与人是否为可选参加。
**可选值有**：
- true：是
- false：否
**注意**：无法编辑群参与人的此字段。
**示例值**：true
**默认值**：`false` user_id | string | 否 | 用户 ID。当选择用户类型参与人（type 取值为 user）时，需要传入该参数。传入的用户 ID 类型需要和 user_id_type 的值保持一致。关于用户 ID 可参见[用户相关的 ID 概念](https://open.larksuite.com/document/home/user-identity-introduction/introduction)。
**示例值**："ou_xxxxxxxx" chat_id | string | 否 | 群组 ID。当选择群组类型参与人（type 取值为 chat）时，需要传入该参数。关于群组 ID 可参见[群 ID 说明](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)。
**示例值**："oc_xxxxxxxxx" room_id | string | 否 | 会议室 ID。当选择会议室类型参与人（type 取值为 resource）时，需要传入该参数。
你可以通过以下接口获取指定会议室 ID：
- [查询会议室列表](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list)
- [搜索会议室](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search)
**示例值**："omm_xxxxxxxx" third_party_email | string | 否 | 邮箱地址。当选择外部邮箱类型参与人（type 取值为 third_party）时，需要传入该参数。
**示例值**："wangwu@email.com" operate_id | string | 否 | 会议室联系人 ID。传入的用户 ID 类型需要和 user_id_type 的值保持一致。关于用户 ID 可参见[用户相关的 ID 概念](https://open.larksuite.com/document/home/user-identity-introduction/introduction)。
**说明**：如果当前日程是基于应用身份创建的，则在添加会议室类型参与人时，需要通过该参数指定会议室的联系人，该联系人会在日程会议室信息中展示。
**默认值**：空
**示例值**："ou_xxxxxxxx" resource_customization | calendar.attendee.resource_customization\[\] | 否 | 会议室的个性化配置。
- 在选择会议室类型参与人时，如果会议室有预定表单，则可以通过该参数配置表单信息。
- 当前添加的参与人不涉及会议室个性化配置时，无需设置该参数。 index_key | string | 是 | 表单内配置的唯一 ID。
**示例值**："16281481596100" input_content | string | 否 | 当配置类型为填空时，需要填入该参数。
**示例值**："xxx" options | customization.option\[\] | 否 | 每个配置的选项。
**示例值**：无 option_key | string | 否 | 选项的唯一 ID。
**示例值**："16281481596185" others_content | string | 否 | 当选项类型为其它选项时，需要填入该参数。
**示例值**："xxx" approval_reason | string | 否 | 申请预定审批会议室的原因。参数配置说明：
- 仅使用用户身份（user_access_token）预定审批会议室时，该字段生效。
- 对于申请预定审批会议室的场景，不传该值会直接预约失败。
- 如果使用应用身份（tenant_access_token）预定审批会议室，会直接失败。
**默认值**：空
**示例值**："申请原因"
**数据校验规则**：
- 最大长度：`200` 字符 need_notification | boolean | 否 | 是否给参与人发送 Bot 通知。
**可选值有**：
- true（默认值）：发送
- false：不发送
**示例值**：false instance_start_time_admin | string | 否 | 使用管理员身份访问时，要修改的日程实例。
**注意**：
- 该参数仅用于修改重复日程中的某一日程实例，非重复日程无需填此字段。
- 你可以调用[获取重复日程实例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event/instances)接口，获取重复日程中某一日程实例的 event_id。该参数取值为 event_id 的时间戳后缀。例如查询到的日程实例 ID 为 `2cf525f0-1e67-4b04-ad4d-30b7f003903c_1713168000`，则当前的 `instance_start_time_admin` 取值为 `1713168000`。
**默认值**：空
**示例值**："1647320400" is_enable_admin | boolean | 否 | 是否启用会议室管理员身份（需先在管理后台设置某成员为会议室管理员)。
**可选值有**：
- true：启用
- false（默认值）：不启用
**说明**：开启后，本次请求只处理会议室数据，其他参与人操作不会生效。
**示例值**：false add_operator_to_attendee | boolean | 否 | 是否添加会议室联系人（operate_id）到日程参与人。
**可选值有**：
- true（默认值）：启用
- false：不启用
**示例值**：false ### 请求体示例 ```json { "attendees": [ { "type": "user", "is_optional": true, "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" } ] } ], "approval_reason": "申请原因" } ], "need_notification": false, "instance_start_time_admin": "1647320400", "is_enable_admin": false, "add_operator_to_attendee": false } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- attendees | calendar.event.attendee\[\] | 添加参与人后，日程参与人列表信息。 type | string | 参与人类型。
**可选值有**：
- user：用户
- chat：群组
- resource：会议室
- third_party：外部邮箱 attendee_id | string | 参与人 ID。日程参与人在当前日程内的唯一标识，后续可通过该 ID 删除日程参与人，或用于查询群组类型参与人的群成员信息。 rsvp_status | string | 参与人 RSVP 状态，即日程回复状态。
**可选值有**：
- needs_action：参与人尚未回复状态，或表示会议室预约中
- accept：参与人回复接受，或表示会议室预约成功
- tentative：参与人回复待定
- decline：参与人回复拒绝，或表示会议室预约失败
- removed：参与人或会议室已经从日程中被移除 is_optional | boolean | 参与人是否为可选参加，该参数值对群组的群成员不生效。 is_organizer | boolean | 参与人是否为日程组织者。 is_external | boolean | 参与人是否为外部参与人。外部参与人不支持编辑。 display_name | string | 参与人名称。 chat_members | attendee_chat_member\[\] | 群成员，当参与人类型为群组（type 为 chat）时有效。群成员不支持编辑。 rsvp_status | string | 参与人 RSVP 状态。
**可选值有**：
- needs_action：参与人尚未回复状态，或表示会议室预约中
- accept：参与人回复接受，或表示会议室预约成功
- tentative：参与人回复待定
- decline：参与人回复拒绝，或表示会议室预约失败
- removed：参与人或会议室已经从日程中被移除 is_optional | boolean | 参与人是否为可选参加。 display_name | string | 参与人名称。 is_organizer | boolean | 参与人是否为日程组织者。 is_external | boolean | 参与人是否为外部参与人。 user_id | string | 用户类型参与人的用户 ID，ID 类型与 user_id_type 的值保持一致。关于用户 ID 可参见[用户相关的 ID 概念](https://open.larksuite.com/document/home/user-identity-introduction/introduction)。
**注意**：当 is_external 返回为 true 时，此字段只会返回 open_id 或者 union_id。 chat_id | string | 群组类型参与人的群组 ID。关于群组 ID 可参见[群 ID 说明](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)。 room_id | string | 会议室类型参与人的会议室 ID。 third_party_email | string | 外部邮箱类型参与人的邮箱地址。 operate_id | string | 如果日程是使用应用身份创建的，在添加会议室时，指定的会议室联系人 ID。ID 类型与 user_id_type 的值保持一致。 resource_customization | calendar.attendee.resource_customization\[\] | 会议室的个性化配置。 index_key | string | 每个配置的唯一 ID。 input_content | string | 填空类型的取值。 options | customization.option\[\] | 每个配置的选项。 option_key | string | 每个选项的唯一 ID。 others_content | string | 其他选项类型的取值。 approval_reason | string | 申请预定审批会议室的原因。参数配置说明：
- 仅使用用户身份（user_access_token）预定审批会议室时，该字段生效。
- 对于申请预定审批会议室的场景，不传该值会直接预约失败。
- 如果使用应用身份（tenant_access_token）预定审批会议室，会直接失败。 ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "attendees": [ { "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" } ] } ] } ] } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 190002 | invalid parameters in request | 无效的请求参数。排查建议如下：
- 确认请求参数的字段名称、传参类型正确。
- 确认已经申请了相应资源的权限。
- 确认相应资源未被删除。 500 | 190003 | internal service error | 内部服务错误，请咨询[技术支持](https://applink.larksuite.com/TLJpeNdW)。 429 | 190004 | method rate limited | 方法频率限制。建议稍后再试，并适当减小请求 QPS。 429 | 190005 | app rate limited | 应用频率限制。建议稍后再试，并适当减小请求 QPS。 403 | 190006 | wrong unit for app tenant | 请求错误，检查应用 App ID 和 App Secret 是否正确。如仍无法解决请咨询[技术支持](https://applink.larksuite.com/TLJpeNdW)。 404 | 190007 | app bot_id not found | 应用的 bot_id 没有找到。你需要确保应用开启了[机器人能力](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。如仍未解决请咨询[技术支持](https://applink.larksuite.com/TLJpeNdW)。 429 | 190010 | current operation rate limited | 当前操作被限流，原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率，然后重试。 403 | 190011 | tenant encrypt key has been deleted | 加解密状态的自主密钥被删除，被该秘钥加密的数据不可用。 403 | 190012 | tenant decrypt key has been deleted | 仅解密状态的自主密钥被删除，被该秘钥加密的数据不可用。 400 | 190013 | content being saved is at risk | 传入的内容被风险控制，请检查内容是否合法。 404 | 191000 | calendar not found | 日历没有找到。你需要检查并改为正确的日历 ID。 400 | 191001 | invalid calendar_id | calendar_id 无效。你需要检查并改为正确的日历 ID。 403 | 191002 | no calendar access_role | 当前身份没有日历的访问权限。如需查询某一日历信息，则需要确保当前身份拥有该日历的访问权限。 403 | 191003 | calendar is deleted | 日历已经被删除。你需要检查并改为正确的日历 ID。 403 | 191004 | invalid calendar type | 日历类型错误。你可以调用[查询日历信息](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口获取日历类型信息，然后确保日历类型适用于当前接口。 400 | 193000 | invalid event_id | event_id 无效。你需要检查并改为正确的日程 ID。 404 | 193001 | event not found | 日程未找到。你需要确保传入了正确的日程 ID。 403 | 193002 | no permission to operate event | 无权限操作。你需要确保有日历以及日程的编辑权限。 403 | 193003 | event is deleted | 日程已经被删除。你需要检查并改为正确的日程 ID。 404 | 194000 | attendee not found | 没有找到参与人。你需要确保参与人相关参数填写正确。 403 | 194001 | no permission to list event attendees | 无操作权限。检查 calendar_id 是否是当前日程组织者日历，或者组织者是否有查看参与人的权限。 403 | 194002 | no permission to create event attendees | 无操作权限。检查 calendar_id 是否是当前日程组织者日历，或者组织者是否有邀请参与人的权限。 403 | 194003 | no permission to delete event attendees | 无操作权限。检查 calendar_id 是否是是当前日程组织者日历。 400 | 194004 | invalid attendee type | 参与人类型无效。需检查参与人类型是否填写正确。 404 | 195100 | user is dismiss or not exist in the tenant | 当前身份或指定用户已经离职，或者不在该租户内。请检查并改为正确的身份来调用接口。 更多错误码信息，参见[通用错误码](https://open.larksuite.com/document/ukTMukTMukTM/ugjM14COyUjL4ITN)。