日程接口获取日历下的日程列表

该接口用于获取指定的日历下的日程列表。
仅可获取应用自己创建的日历下的日程。
当日程较多时，需要使用参数是offset及limit 分页获取，注意offset是以0为起点，这里以图例简单说明：
https://p.qpic.cn/pic_wework/23479275/c4c278d43a5f745881cf2b83b6c955e1a7f0091d48fb0822/0[https://p.qpic.cn/pic_wework/23479275/c4c278d43a5f745881cf2b83b6c955e1a7f0091d48fb0822/0]
page_size/page_index图示说明
当获取到的 schedule_list 是空的时候，表示offset已经过大，此时应终止获取。若有新增日程，可在此基础上继续增量获取。

注意，被取消的日程也可以拉取详情，调用者需要检查status

文档ID: 26903
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/93648
https://open.work.weixin.qq.com/api/doc/90001/90143/93703

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

offset

integer <int32>

可选

分页，偏移量, 默认为0

cal_id

string

日历ID

必需

limit

integer <int32>

可选

分页，预期请求的数据量，默认为500，取值范围 1 ~ 1000

示例

{
    "cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA",
    "offset": 100,
    "limit": 1000
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

可选

errmsg

string

可选

schedule_list

array [object {12}]

可选

summary

string

日程标题

可选

reminders

object

提醒相关信息

可选

sequence

integer <int32>

可选

日程编号，是一个自增数字

start_time

integer <int32>

可选

日程开始时间，Unix时间戳

cal_id

string

可选

日程所属日历ID。该日历必须是access_token所对应应用所创建的日历。注意，这个日历必须是属于组织者(organizer)的日历；如果不填，那么插入到组织者的默认日历上。第三方应用必须指定cal_id 不多于64字节

attendees

array [object {2}]

可选

日程参与者列表。最多支持2000人

end_time

integer <int32>

可选

日程结束时间，Unix时间戳

description

string

日程描述

可选

location

string

可选

日程地址不多于128个字符

schedule_id

string

可选

status

integer <int32>

可选

日程状态。0-正常；1-已取消

organizer

string

必需

组织者不多于64字节

示例

{
    "errcode": 0,
    "errmsg": "string",
    "schedule_list": [
        {
            "summary": "string",
            "reminders": {
                "remind_before_event_secs": 0,
                "is_repeat": 0,
                "repeat_type": 0,
                "timezone": 0,
                "repeat_until": 0,
                "is_remind": 0,
                "repeat_interval": 0,
                "repeat_day_of_month": [
                    0
                ],
                "repeat_day_of_week": [
                    0
                ],
                "is_custom_repeat": 0
            },
            "sequence": 0,
            "start_time": 0,
            "cal_id": "string",
            "attendees": [
                {
                    "response_status": 0,
                    "userid": "string"
                }
            ],
            "end_time": 0,
            "description": "string",
            "location": "string",
            "schedule_id": "string",
            "status": 0,
            "organizer": "string"
        }
    ]
}

日程接口 获取日历下的日程列表

请求参数

示例代码

返回响应

日程接口获取日历下的日程列表