获取日历下的日程列表

该接口用于获取指定的日历下的日程列表。

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/get_by_calendar?access_token=ACCESS_TOKEN

请求包体:

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

参数说明:

参数 是否必须 说明
cal_id 日历ID
offset 分页,偏移量, 默认为0
limit 分页,预期请求的数据量,默认为500,取值范围 1 ~ 1000

当日程较多时,需要使用参数是offsetlimit 分页获取,注意offset是以0为起点,这里以图例简单说明:
page_size/page_index图示说明
当获取到的 schedule_list 是空的时候,表示offset已经过大,此时应终止获取。若有新增日程,可在此基础上继续增量获取。

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
    "schedule_list": [
        {
            "schedule_id": "17c7d2bd9f20d652840f72f59e796AAA",
            "sequence": 100,
            "attendees": [
                {
                    "userid": "userid1",
                    "response_status": 0
                }
            ],
            "summary": "test_summary",
            "description": "test_content",
            "reminders": {
                "is_remind": 1,
                "is_repeat": 1,
                "remind_before_event_secs": 3600,
                "repeat_type": 7
            },
            "location": "test_place",
            "start_time": 1571274600,
            "end_time": 1571320210,
            "status": 1,
            "cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA"
        }
    ]
}

参数说明:

参数 说明
errcode 错误码
errmsg 错误码说明
schedule_list 日程列表
schedule_id 日程ID
sequence 日程编号,是一个自增数字
start_time 日程开始时间,Unix时间戳
end_time 日程结束时间,Unix时间戳
attendees 日程参与者列表。最多支持2000人
userid 日程参与者ID
response_status 日程参与者的接受状态。
0 - 未处理
1 - 待定
2 - 全部接受
3 - 仅接受一次
4 - 拒绝
summary 日程标题。0 ~ 128 字符。不填会默认显示为“新建事件”
description 日程描述。0 ~ 512 字符
reminders 提醒相关信息
is_remind 是否需要提醒。0-否;1-是
remind_before_event_secs 日程开始(start_time)前多少秒提醒,当is_remind为1时有效。例如: 300表示日程开始前5分钟提醒。目前仅支持以下数值:
0 - 事件开始时
300 - 5分钟
900 - 15分钟
3600 - 1小时
86400 - 1天
is_repeat 是否重复日程。0-否;1-是
repeat_type 重复类型,当is_repeat为1时有效。目前支持如下类型:
0 - 每日
1 - 每周
2 - 每月
5 - 每年
7 - 工作日
location 日程地址。0 ~ 128 字符
cal_id 日程所属日历ID
status 日程状态。0-正常;1-已取消

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

© 1998 - 2020 Tencent Inc. All Rights Reserved