查询单个日程详情新版SDK

更新于 2023-08-23

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，根据日程id查询单个日程详情。

例如，某日程如下图所示。调用本接口，可获取日程标题、日程开始日期、开始时间、结束日期和结束时间等

权限

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

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

请求方法

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。
第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。
第三方个人应用，调用获取用户token接口获取。

Path参数

名称	类型	是否必填	描述
userId	String	是	日程所属用户的unionId。企业内部应用，调用查询用户详情接口获取unionid参数值。第三方企业应用，调用查询用户详情接口获取unionid参数值。第三方个人应用，调用获取用户通讯录个人信息接口获取unionId参数值。
calendarId	String	是	日程所属的日历Id，统一为primary，表示用户的主日历。
eventId	String	是	日程ID。企业内部应用，调用创建日程接口或查询日程列表接口获取id参数值。第三方企业应用，调用创建日程接口或查询日程列表接口获取id参数值。第三方个人应用，调用创建日程接口或查询日程列表接口获取id参数值。

Query参数

名称	类型	是否必填	描述
maxAttendees	Long	否	最大参与人数，默认值100，最大值500。

返回参数

名称	类型	描述
id	String	日程id。
summary	String	日程标题。
description	String	日程描述。
status	String	日程状态。 confirmed：正常 cancelled：已取消
start	Object	日程开始时间。
date	String	日程开始日期，格式：yyyy-MM-dd。说明全天日程必须有值非全天日程必须留空
dateTime	String	日程开始时间，格式为ISO-8601的date-time格式。说明全天日程必须留空非全天日程必须有值
timeZone	String	日程开始时间所属时区，TZ database name格式。说明全天日程必须留空非全天日程必须有值
originStart	Object	表示循环序列中最初创建时的开始时间。说明对于普通单个日程，不返回此属性。
dateTime	String	其日期和时间信息以 ISO 8601 格式表示，并且始终采用 UTC。例如：`2023 年 1 月 1 日午夜 UTC 为 2023-01-01T00:00:00Z`。
end	Object	日程结束时间。
date	String	日程结束日期，格式：yyyy-MM-dd。说明全天日程必须有值非全天日程必须留空
dateTime	String	日程结束时间，格式为ISO-8601的date-time格式。说明全天日程必须留空非全天日程必须有值
timeZone	String	日程结束时间所属时区，必须和开始时间所属时区相同，TZ database name格式。说明全天日程必须留空非全天日程必须有值
isAllDay	Boolean	是否为全天日程。 true：是 false：不是
recurrence	Object	日程循环规则。
pattern	Object	重复模式。
type	String	循环规则类型。 daily：每`interval`天重复 weekly：每`interval`周的第`daysOfWeek`天重复 absoluteMonthly：每`interval`月的第`dayOfMonth`天重复 relativeMonthly：每`interval`月的第`index`周的第`daysOfWeek`天重复 absoluteYearly：每`interval`年重复
dayOfMonth	Integer	当`type=absoluteMonthly`时，用于指定是每个月的第几天。
daysOfWeek	String	英文小写单词指定星期几，如果有多个值逗号分割。
index	String	当`type=relativeMonthly`时，用于指定每月第几周。 first second third fourth last 其中`last`表示当月的最后一周。
interval	Integer	循环间隔，根据type不同单位不同。例如当`type=daily`时表示间隔N天，`type=absoluteYearly`则表示间隔N年。
firstDayOfWeek	String	一周起始日，可取值包括：sunday、monday、tuesday、wednesday、thursday、friday、saturday。默认值为“sunday”。
range	Object	循环范围。
type	String	循环范围类型。 noEnd：永不结束 endDate：循环至指定日期结束 numbered：循环指定次数后结束
endDate	String	循环结束时间。
numberOfOccurrences	Integer	循环次数。
attendees	Array	参与人列表。
id	String	用户的unionId。
displayName	String	用户名。
responseStatus	String	回复状态。
self	Boolean	是否是当前登陆用户。 true：是 false：不是
isOptional	Boolean	是否为可选参与人。 true：是 false：不是
organizer	Object	组织者。
id	String	组织者unionId。
displayName	String	用户名。
responseStatus	String	回复状态。
self	Boolean	是否是当前登陆用户。 true：是 false：不是
location	Object	日程地点相关信息。
displayName	String	日程地点名称。
seriesMasterId	String	重复日程的主日程id，非重复日程为空。
createTime	String	创建时间。
updateTime	String	更新时间。
reminders	Array	日程提醒
method	String	提醒方式。
minutes	String	在日程开始前N分钟发出提醒。
onlineMeetingInfo	Object	线上会议。
type	String	线上会议类型，目前支持： dingtalk：钉钉视频会议
conferenceId	String	会议ID。
url	String	参会的url地址。
extraInfo	Map	其他扩展信息。
extendedProperties	Object	日程拓展属性。
sharedProperties	Object	共享属性。
sourceOpenCid	String	当日程是由某个群内发起的时候，该字段表示日程发起的来源群。
belongCorpId	String	日程归属的企业corpId。
meetingRooms	Array	会议室。
roomId	String	会议室roomId。
responseStatus	String	会议室响应状态。 accepted : 接受 tentative: 审批中 declined : 审批未通过
displayName	String	会议室名称。
categories	Array	日程类型。
displayName	String	日程类型名称。
richTextDescription	Object	富文本描述。
text	String	富文本描述内容。

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter	forwardErrorMessage	参数异常
404	instanceNotExist	instance not exist	循环日程实例不存在
404	itemNotFound	forwardErrorMessage	无法找到指定日程

这篇文档是否有帮助？

本页内容