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

该接口用于获取指定的日历下的日程列表。
仅可获取应用自己创建的日历下的日程。

当日程较多时，需要使用参数是offset及limit 分页获取，注意offset是以0为起点，这里以图例简单说明：
page_size/page_index图示说明

当获取到的 schedule_list 是空的时候，表示offset已经过大，此时应终止获取。若有新增日程，可在此基础上继续增量获取。

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

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/get_by_calendar?access_token=' \ --header 'Content-Type: application/json' \ --data-raw '{"cal_id":"wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA","offset":100,"limit":1000}'

{ "errcode": 0, "errmsg": "ok", "schedule_list": [ { "schedule_id": "17c7d2bd9f20d652840f72f59e796AAA", "sequence": 100, "admins": [ "admin1", "admin2" ], "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, "repeat_until": 1606976813, "is_custom_repeat": 1, "repeat_interval": 1, "repeat_day_of_week": [ 3, 7 ], "repeat_day_of_month": [ 10, 21 ], "timezone": 8 }, "location": "test_place", "start_time": 1571274600, "end_time": 1571320210, "status": 1, "cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA" } ] }

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

offset

integer <int32>

可选

分页，偏移量, 默认为0

cal_id

string

日历ID

必需

limit

integer <int32>

可选

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

示例

返回响应

🟢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字节

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

请求参数

返回响应

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