Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

修改日程

修改日程,当 calendar_id = primary 时, 操作的是主日历下的数据

请求说明

请求地址https://openapi.wps.cn/v7/calendars/{calendar_id}/events/{event_id}/update
请求方法POST
签名方式KSO-1
权限要求查询和管理日程信息(应用授权) kso.calendar_events.readwrite
查询和管理日程信息(用户授权) kso.calendar_events.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
calendar_idstring
event_idstring

请求体(Body)

名称参数类型是否必填说明
calendar_idstring切换日历,日历 id; calendar.id
descriptionstring备注
end_timeobject结束时间
∟ datestring日期,采用 “yyyy-mm-dd” 格式的日期,参考 rfc3339 full-date,日程为全天日程时,此字段的时区固定为'UTC'
∟ datetimestring时间,格式需满足 RFC3339; date 与 datetime 互斥,二选一,全天场景下使用 date
free_busy_statusstring[enum]
busyfree
is_reinvitionboolean是否重置邀请;当设置为 true 并且日程时间属性(开始、结束时间、重复规则等)被修改时,所有参与者会重置为未接受,默认为 true
locationsarray[object]地址
∟ namestring
online_meetingobject在线会议,null 为清理
∟ providerstring在线会议提供商;kso:金山会议
∟ urlstring在线会议跳转链接
recurrenceobject
∟ by_dayarray[string]周几, MO(周一), TU, WE, TH, FR, SA, SU(周日); 若需要每个月第二个星期一,这里为 2MO
∟ by_montharray[integer]表示一年的第几个月
∟ by_month_dayarray[integer]表示一个月的第几天,最小 1,最大 31, 不能为 0
∟ countinteger重复次数
∟ exdatearray[object]排除日期
∟ ∟ datestring日期,采用 “yyyy-mm-dd” 格式的日期,参考 rfc3339 full-date,日程为全天日程时,此字段的时区固定为'UTC'
∟ ∟ datetimestring时间,格式需满足 RFC3339; date 与 datetime 互斥,二选一,全天场景下使用 date
∟ freqstringYEARLY : 表示以年为间隔单位进行重复

MONTHLY : 表示以月为间隔单位进行重复

WEEKLY : 表示以周为间隔单位进行重复

DAILY : 表示以天为间隔单位进行重复

LUNAR_YEARLY : 表示农历以年为间隔单位进行重复(农历场景下仅支持 by_month_day,by_month,count,until_date,interval 属性)
∟ intervalinteger重复规则的间隔
∟ until_dateobject重复规则截止日期
∟ ∟ datestring日期,采用 “yyyy-mm-dd” 格式的日期,参考 rfc3339 full-date,日程为全天日程时,此字段的时区固定为'UTC'
∟ ∟ datetimestring时间,格式需满足 RFC3339; date 与 datetime 互斥,二选一,全天场景下使用 date
remindersarray[object]提醒
∟ minutesinteger正数时表示在日程开始前 X 分钟提醒,负数时表示在日程开始后 X 分钟提醒,正点提醒为 0;范围为 [-10080,10080]
start_timeobject开始时间
∟ datestring日期,采用 “yyyy-mm-dd” 格式的日期,参考 rfc3339 full-date,日程为全天日程时,此字段的时区固定为'UTC'
∟ datetimestring时间,格式需满足 RFC3339; date 与 datetime 互斥,二选一,全天场景下使用 date
summarystring标题
visibilitystring[enum]
defaultpublicprivate

请求地址示例

[POST] https://openapi.wps.cn/v7/calendars/{calendar_id}/events/{event_id}/update

请求体示例

json
{
  "calendar_id": "string",
  "description": "string",
  "end_time": {
    "date": "string",
    "datetime": "string"
  },
  "free_busy_status": "string[enum]",
  "is_reinvition": false,
  "locations": [
    {
      "name": "string"
    }
  ],
  "online_meeting": {
    "provider": "string",
    "url": "string"
  },
  "recurrence": {
    "by_day": [
      "string"
    ],
    "by_month": [
      0
    ],
    "by_month_day": [
      0
    ],
    "count": 0,
    "exdate": [
      {
        "date": "string",
        "datetime": "string"
      }
    ],
    "freq": "string",
    "interval": 0,
    "until_date": {
      "date": "string",
      "datetime": "string"
    }
  },
  "reminders": [
    {
      "minutes": 0
    }
  ],
  "start_time": {
    "date": "string",
    "datetime": "string"
  },
  "summary": "string",
  "visibility": "string[enum]"
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "msg": "string"
}
回到旧版