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

查询日程列表 ​

查询日程列表，当 calendar_id = primary 时， 查询的是主日历下的数据

请求说明 ​

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

请求头（Header） ​

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

路径参数（Path） ​

名称参数类型说明
calendar_idstring

查询参数（Query） ​

名称参数类型是否必填说明
end_timestring是结束查询时间，需要 url 编码
page_sizeinteger否最多返回 page_size 个数据，默认为 30
page_tokenstring否分页 token
start_timestring是开始查询时间，需要 url 编码， 0 < 结束 - 开始 <=31 天

请求地址示例 ​

[GET] https://openapi.wps.cn/v7/calendars/{calendar_id}/events?end_time={string}&page_size={integer}&page_token={string}&start_time={string}

响应体 ​

名称参数类型说明
codeinteger响应代码。非 0 表示失败，参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]
∟ ∟ calendar_idstring日历 id; calendar.id
∟ ∟ descriptionstring备注
∟ ∟ end_timeobject结束时间
∟ ∟ ∟ datestring日期，采用 “yyyy-mm-dd” 格式的日期，参考 rfc3339 full-date，日程为全天日程时，此字段的时区固定为'UTC'
∟ ∟ ∟ datetimestring时间，格式需满足 RFC3339; date 与 datetime 互斥，二选一，全天场景下使用 date
∟ ∟ free_busy_statusstring忙闲状态；busy：该日程对应的时间段在日历忙闲上标记为忙碌；free：该日程对应的时间段在日历忙闲上标记为空闲
∟ ∟ idstring日程 id
∟ ∟ locationsarray[object]地址
∟ ∟ ∟ namestring
∟ ∟ online_meetingobject在线会议
∟ ∟ ∟ providerstring在线会议提供商；kso：金山会议
∟ ∟ ∟ urlstring在线会议跳转链接
∟ ∟ organizerobject组织者
∟ ∟ ∟ typestring组织者类型， user：用户类型
∟ ∟ ∟ user_idstring用户 id;v7_user.id
∟ ∟ original_start_timeobject所属重复日程被编辑的那一天，用以组装数据时，排除重复日程的某一天；更详细见 event.recurrence 字段
∟ ∟ ∟ datestring日期，采用 “yyyy-mm-dd” 格式的日期，参考 rfc3339 full-date，日程为全天日程时，此字段的时区固定为'UTC'
∟ ∟ ∟ datetimestring时间，格式需满足 RFC3339; date 与 datetime 互斥，二选一，全天场景下使用 date
∟ ∟ 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
∟ ∟ recurrence_start_time_listarray[object]重复日期，用来描述重复展开，例如周一到周五重复，则这里会返回周一到周五的开始时间，但注意可能会受筛选条件影响
∟ ∟ ∟ datestring日期，采用 “yyyy-mm-dd” 格式的日期，参考 rfc3339 full-date，日程为全天日程时，此字段的时区固定为'UTC'
∟ ∟ ∟ datetimestring时间，格式需满足 RFC3339; date 与 datetime 互斥，二选一，全天场景下使用 date
∟ ∟ recurring_event_idstring所属的重复日期的 id。固定不变；非重复子日程场景下为空，更详细见 event.recurrence 字段
∟ ∟ 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可见范围；default：默认，public：公开，private：不公开
∟ next_page_tokenstring
moreobject更多的错误信息

响应体示例 ​

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "calendar_id": "string",
        "description": "string",
        "end_time": {
          "date": "string",
          "datetime": "string"
        },
        "free_busy_status": "string",
        "id": "string",
        "locations": [
          {
            "name": "string"
          }
        ],
        "online_meeting": {
          "provider": "string",
          "url": "string"
        },
        "organizer": {
          "type": "string",
          "user_id": "string"
        },
        "original_start_time": {
          "date": "string",
          "datetime": "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"
          }
        },
        "recurrence_start_time_list": [
          {
            "date": "string",
            "datetime": "string"
          }
        ],
        "recurring_event_id": "string",
        "reminders": [
          {
            "minutes": 0
          }
        ],
        "start_time": {
          "date": "string",
          "datetime": "string"
        },
        "summary": "string",
        "visibility": "string"
      }
    ],
    "next_page_token": "string"
  },
  "msg": "string"
}
回到旧版