跳转至

CreateCalendarEvent

在用户的日历上准备一个事件，并通过其连接的提供商邀请所有列出的与会者。在 Macro 聊天中，此工具会打开一个内联编辑器，让用户查看、编辑和确认事件；请使用该工具来呈现提议，而不是在文字中要求重复确认。当待处理的调用被执行时，事件会立即写入日历提供商，与会者会收到邀请。其他客户端应在执行调用前确认涉及与会者的事件。请勿将其用于来自频道或文档线程的提示——如果确实如此，上下文块会指明会话父级，并且没有可审阅草稿的界面：请在回复中写出事件，询问是否创建，并在用户批准后使用 CreateConfirmedCalendarEvent。

事件默认落在用户的主日历上，除非 calendarId（来自 ListCalendars）指定了其他日历。对于重复事件，在 recurrenceLines 中传入 RFC 5545 行，例如 ["RRULE:FREQ=WEEKLY;BYDAY=MO"]。返回创建的事件及其 eventId，供日后更新或删除。如果用户没有连接可写的日历，则调用失败。

对于视频会议，最多选择以下之一：addMacroCall（Macro 会议链接，Macro 用户会议的默认选择）或 addConference（Google Meet 或 Microsoft Teams，取决于日历能力）。系统会为用户创建一场 Macro 通话，安排在该事件的时间段内，并将其加入链接附加到事件的描述中，以便每位与会者的邀请都包含该链接；除非提供了实际地点 location，否则它也会成为事件的 location。返回事件的 macroCallUrl 中包含该链接。

将 eventType 设置为 "out_of_office" 可将用户标记为外出（例如“把我标记为周四外出”）。外出事件必须落在用户的主日历上（省略 calendarId），必须是定时事件而非全天事件，并且不能包含与会者或视频会议（将 addMacroCall 和 addConference 设为 false）；使用 outOfOffice 控制是否自动拒绝冲突的会议。此类型之后无法更改。

参数

参数 类型 必填 描述
title string 是 事件标题。
time EventTimeInput 是 提供给日历工具的互斥时间结构。
description string 否 可选的事件正文/描述。
location string 否 可选的实际或虚拟位置标签。
attendees AttendeeInput[] 否 通过电子邮件邀请的与会者。事件创建后，日历提供商会立即通知他们。单人事件可省略。
recurrenceLines string[] 否 RFC 5545 原始重复规则行（RRULE、RDATE、EXDATE），例如 ["RRULE:FREQ=WEEKLY;BYDAY=MO,WE"]。一次性事件可省略。
calendarId string 否 要在其上创建事件的日历，来自 ListCalendars。省略则使用用户的主日历。
reminders EventRemindersInput 否 事件的提醒配置。省略则使用所选日历的默认设置。
addMacroCall boolean 否 将新创建的 Macro 通话附加到事件：一个按事件时间调度的 Macro 会议链接，写入事件的位置和描述。与 addConference 互斥。
addConference boolean 否 附加该日历支持的会议：Google Meet 或 Microsoft Teams。请先查看 ListCalendars 的能力。
eventType "default" | "out_of_office" 否 创建工具调用所生成的事件类型。
outOfOffice OutOfOfficeInput 否 外出时的拒绝行为，仅当 eventType 为 "out_of_office" 时使用。省略则仅占用该时间段；将 autoDeclineMode 设置为 "decline_all" 或 "decline_new_only" 可让日历集成拒绝冲突的会议，并可选附带 declineMessage。
guestPolicy GuestPolicy 否 与会者可以做什么：canModify（修改事件；隐含 canInviteOthers）、canInviteOthers 和 canSeeOtherGuests。省略则使用默认值：与会者可以邀请他人并查看与会者列表，但不能修改事件。仅适用于 Google 日历；Outlook 日历会拒绝此设置。

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 macro3/macro