资源工坊

查询日程实例列表 ​

标签：日程

请求说明 ​

字段值
请求地址
https://openapi.wps.cn/v7/calendars/{calendar_id}/event_instances
HTTP 方法
GET
接口描述
查询日程实例列表，会将重复日程展开为具体的日程实例。当 calendar_id = primary 时，查询的是主日历下的数据
签名方式
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”-

响应体(Response) ​

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

没有可用的数据

响应体示例 ​

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",
          "meeting_setting": {
            "auto_recording": "off",
            "host_id": "string",
            "is_allow_attendees_start": true,
            "is_open_lobby": true,
            "join_permission": "anyone",
            "meeting_type": "general",
            "mute_on_join": "off",
            "recording_view_permission": "organizer_only",
            "require_camera_on_join": true
          },
          "provider": "kso",
          "url": "string"
        },
        "organizer": {
          "type": "user",
          "user_id": "string"
        },
        "recurring_event_id": "string",
        "reminders": [
          {
            "minutes": 0
          }
        ],
        "start_time": {
          "date": "string",
          "datetime": "string"
        },
        "status": "normal",
        "summary": "string",
        "visibility": "default"
      }
    ]
  },
  "code": 0,
  "msg": "string"
}