查询日程列表

说明

调用本接口查询一个用户给定时间范围内的日程，支持翻页和增量查询。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	日历应用中日程读权限	API Explorer
第三方企业应用	暂不支持	日历应用中日程读权限	暂不支持
第三方个人应用	支持	日历应用中日程读权限	API Explorer

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter	forwardErrorMessage	参数异常

请求参数

Path 参数

userId

string

必需

查询目标用户的unionId，可通过根据userid获取用户详情接口获取。

calendarId

string

必需

日程所属的日历id，统一为primary，表示用户的主日历。

Query 参数

timeMin

string

可选

日程开始时间的最小值，格式为ISO-8601的date-time格式，可不填。

timeMax

string

可选

日程开始时间的最大值，格式为ISO-8601的date-time格式，可不填。

showDeleted

string

可选

是否返回已取消/删除的日程，默认不返回。

maxResults

string

可选

最大返回记录数，最大值100，默认值100。

nextToken

string

可选

分页游标。
如果一个查询条件一次无法全部返回结果，会返回分页token，下次查询带上该token后会返回后续数据，直到分页token为null表示数据已经全部查询完毕。

syncToken

string

可选

同步token，用于增量数据同步场景，一个查询条件已经返回全部数据后（如果数据比较多会分页返回，调用方需要连续使用nextToken查询，直到所有分页都查完nextToken返回null之后），会返回一个syncToken，下次带着该token来查询会返回两次查询之间发生变更的增量数据。
如果传入了timeMax，则不会返回syncToken。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用服务端接口的授权凭证。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

nextToken

string

翻页token。

可选

events

array [object {15}]

日程。

可选

string

日程id。

可选

summary

string

日程标题。

可选

description

string

日程描述。

可选

start

object

日程开始时间。

可选

end

object

日程结束时间。

可选

isAllDay

boolean

是否为全天日程。

可选

recurrence

object

日程循环规则。

可选

attendees

array [object {4}]

日程参与人。

可选

organizer

object

日程组织人。

可选

location

object

日程地点。

可选

seriesMasterId

string

可选

重复日程的主日程id，非重复日程为空。

createTime

string

创建时间。

可选

updateTime

string

更新时间。

可选

status

string

日程状态。

可选

onlineMeetingInfo

object

线上会议

可选

syncToken

string

可选

增量同步token。

示例

{
  "nextToken": "string",
  "events": [
    {
      "id": "string",
      "summary": "string",
      "description": "string",
      "start": {
        "date": "string",
        "dateTime": "string",
        "timeZone": "string"
      },
      "end": {
        "date": "string",
        "dateTime": "string",
        "timeZone": "string"
      },
      "isAllDay": true,
      "recurrence": {
        "pattern": {
          "type": "string",
          "dayOfMonth": 0,
          "daysOfWeek": "string",
          "index": "string",
          "interval": 0
        },
        "range": {
          "type": "string",
          "endDate": "string",
          "numberOfOccurrences": 0
        }
      },
      "attendees": [
        {
          "id": "string",
          "displayName": "string",
          "responseStatus": "string",
          "self": true
        }
      ],
      "organizer": {
        "id": "string",
        "displayName": "string",
        "responseStatus": "string",
        "self": true
      },
      "location": {
        "displayName": "string"
      },
      "seriesMasterId": "string",
      "createTime": "string",
      "updateTime": "string",
      "status": "string",
      "onlineMeetingInfo": {
        "type": "string",
        "conferenceId": "string",
        "url": "string",
        "extraInfo": {}
      }
    }
  ],
  "syncToken": "string"
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码