跳到主要内容

创建日程

POST/v2/users/:email/calendars/:calendarId/events

在指定日历中创建约会或会议。

必填字段​

  • 创建约会：subject、start、end。
  • 创建会议：subject、start、end、organizer、attendees、notify。

创建循环日程后，可调用“查询时间范围内的日程”接口获取展开后的单次日程，再使用单次日程 ID 或循环主日程 ID（seriesMasterId）执行后续操作。

Request​

Path parameters

    email stringrequired
    calendarId stringrequired

请求体参数

    event object
    subject string

    日程主题

    organizer object

    日程组织者

    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    locations object[]

    日程地点

    type enum
    • defaultLocation:

    Possible values: [defaultLocation]

    name string
    reminders object[]

    日程提醒

    method enum
    • display:

    Possible values: [display]

    minutes number<int32>

    提前N分钟显示提醒

    start object

    日程开始时间

    date string

    格式：2023-06-01，全天日程生效

    dateTime string

    格式：2023-06-01T08:00:00，非全天日程生效

    timezone string

    非全天日程，isUtc=false时生效

    isUtc boolean

    非全天日程生效

    end object

    日程结束时间

    date string

    格式：2023-06-01，全天日程生效

    dateTime string

    格式：2023-06-01T08:00:00，非全天日程生效

    timezone string

    非全天日程，isUtc=false时生效

    isUtc boolean

    非全天日程生效

    attendees object[]

    日程参会人

    user object
    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    type enum
    • required:
    • optional:

    Possible values: [required, optional]

    body object

    日程正文

    bodyText string

    邮件文本格式正文

    bodyHtml string

    邮件html格式正文

    recurrence object

    日程循环规则, type=seriesMaster时生效

    pattern object
    type enum
    • daily: 每interval天重复
    • weekly: 每interval周的第daysOfWeek天重复
    • absoluteMonthly: 每interval月的第dayOfMonth天重复
    • relativeMonthly: 每interval月的第index个daysOfWeek重复
    • absoluteYearly: 每interval年第month月的第dayOfMonth天重复
    • relativeYearly: 每interval年第month月的第index个daysOfWeek重复

    Possible values: [daily, weekly, absoluteMonthly, relativeMonthly, absoluteYearly, relativeYearly]

    interval number<int32>

    循环间隔, 含义随type而定。比如：type=daily，表示间隔interval天；type=weekly, 表示间隔interval周

    month number<int32>

    月份，有效值 (1 - 12)

    dayOfMonth number<int32>

    月内第几天，有效值 (1 - 31)

    index enum

    specifies on which instance of the allowed days specified in daysOfWeek

    • first:
    • second:
    • third:
    • fourth:
    • last:

    Possible values: [first, second, third, fourth, last]

    daysOfWeek enum[]

    daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.for example: index=last daysOfWeek=[monday, tuesday, wednesday, thursday, friday] means last workday of month

    Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

    firstDayOfWeek enum
    • sunday:
    • monday:
    • tuesday:
    • wednesday:
    • thursday:
    • friday:
    • saturday:

    Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

    range object
    type enum
    • noEnd: 永不结束
    • dateEnd: 循环至endDate结束
    • numbered: 循环numberOfOccurrences次后结束

    Possible values: [noEnd, dateEnd, numbered]

    endDate string

    循环结束日期, 格式: 2023-06-01

    numberOfOccurrences number<int32>

    循环次数

    cancelledOccurrences string[]

    循环规则中已取消的单次日程，更新循环主日程时生效：不更新recurrence，cancelledOccurrences也保持不变；更新recurrence，则需要清空cancelledOccurrences

    extensions object

    日程扩展信息

    property name* string

    日程扩展信息

    notify boolean

    是否发送日程通知邮件

响应

    eventId string

错误

400Bad Request
401

访问未授权，请检查是否传递了正确的授权token

403

无API访问权限，请在域管的应用管理页面完成相关授权

404Not Found