查询日程列表

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

标签：日程

请求说明

字段	值
请求地址	https://openapi.wps.cn/v7/calendars/{calendar_id}/events
HTTP 方法	GET
接口描述	查询日程列表，当 calendar_id = primary 时， 查询的是主日历下的数据，目前有2类使用方式，1. 查询指定时间区间内的日程（start_time 和 end_time 配合使用），2. 查询指定时间锚点之后发生变更的日程（先使用anchor_time获取存量日程，存量获取结束后会返回next_sync_token，后续使用next_sync_token作为sync_token入参的值获取增量日程）
签名方式	KSO-1
限频策略	无
权限要求	查询日程(应用授权) kso.calendar_events.read 查询和管理日程信息(应用授权) kso.calendar_events.readwrite 查询日程(用户授权) kso.calendar_events.read 查询和管理日程信息(用户授权) kso.calendar_events.readwrite

请求头 (Headers)

属性名	类型	是否必填	描述	可选值
X-Kso-Id-Type	string	否	类型 * internal - 内部 * external - 外部	internal, external

路径参数 (Path)

属性名	类型	是否必填	描述	可选值
calendar_id	string	是	日历id，可从日历列表、主日历详情获取，或使用primary指代用户的主日历	-

查询参数 (Query)

属性名	类型	是否必填	描述	可选值
start_time	string	否	开始查询时间，RFC3339格式，需要url编码， 配合end_time使用查询指定区间内的日程，0<结束-开始<=31天，例如“2024-01-15T14%3A30%3A00%2B08%3A00”	-
end_time	string	否	结束查询时间，RFC3339格式，需要url编码， 配合start_time使用查询指定区间内的日程，0<结束-开始<=31天，例如“2024-01-15T14%3A30%3A00%2B08%3A00”	-
page_token	string	否	分页token	-
page_size	integer	否	最多返回 page_size 个数据，默认为30	-
with_cancelled	boolean	否	是否包含已取消的日程，用于增量同步，注意仅返回 id 和 部分基础信息，请勿依赖其他字段， 根据id删除本地数据即可	-
sync_token	string	否	增量同步标记，一个查询条件已经返回全部数据后，会返回 next_sync_token字段，下次遍历可用该字段的值作为 sync_token 获取自上一次以来发生变更的日程列表（在上次查询之后创建及被修改的日程都会返回）。	-
anchor_time	string	否	时间锚点，RFC3339格式，指定拉取该时间点之后发生变更的日程数据（在该时间点之后创建及被修改的日程都会返回），例如“2024-01-15T14%3A30%3A00%2B08%3A00”	-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

{
  "data": {
    "items": [
      {
        "calendar_id": "string",
        "description": "string",
        "end_time": {
          "date": "string",
          "datetime": "string"
        },
        "free_busy_status": "busy",
        "id": "string",
        "locations": [
          {
            "name": "string"
          }
        ],
        "online_meeting": {
          "description": "string",
          "provider": "kso",
          "url": "string"
        },
        "organizer": {
          "type": "user",
          "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": "YEARLY",
          "interval": 0,
          "until_date": {
            "date": "string",
            "datetime": "string"
          }
        },
        "recurring_event_id": "string",
        "reminders": [
          {
            "minutes": 0
          }
        ],
        "start_time": {
          "date": "string",
          "datetime": "string"
        },
        "status": "normal",
        "summary": "string",
        "visibility": "default"
      }
    ],
    "next_page_token": "string",
    "next_sync_token": "string"
  },
  "code": 0,
  "msg": "string"
}