查询单个日程详情
GET
/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口根据日程id查询单个日程详情。
服务地址:api.dingtalk.com
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 日历应用中日程读权限 | API Explorer |
第三方企业应用 | 暂不支持 | 日历应用中日程读权限 | 暂不支持 |
第三方个人应用 | 支持 | 日历应用中日程读权限 | API Explorer |
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParameter | forwardErrorMessage | 参数异常 |
404 | itemNotFound | forwardErrorMessage | 无法找到指定日程 |
请求参数
Path 参数
userId
string
必需
日程所属用户的unionId,可通过根据userid获取用户详情接口获取。
calendarId
string
必需
日程所属的日历id,统一为primary,表示用户的主日历。
eventId
string
日程id。
Header 参数
x-acs-dingtalk-access-token
string
必需
调用服务端接口的授权凭证。
Body 参数application/json
object {0}
示例
{}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
id
string
日程id。
summary
string
日程标题。
description
string
日程描述。
status
string
日程状态:
start
object
日程开始时间。
date
string
可选
日程开始日期,格式:yyyy-MM-dd。
如果是全天日程必须有值,非全天日程必须留空。
dateTime
string
可选
日程开始时间,格式为ISO-8601的date-time格式。
非全天日程必须有值,全天日程必须留空。
timeZone
string
可选
日程开始时间所属时区,TZ database name格式
非全天日程必须有值,全天日程必须留空。
end
object
日程结束时间。
date
string
可选
日程结束日期,格式:yyyy-MM-dd。
如果是全天日程必须有值,非全天日程必须留空。
dateTime
string
可选
日程结束时间,格式为ISO-8601的date-time格式。
非全天日程必须有值,全天日程必须留空。
timeZone
string
可选
日程结束时间所属时区,必须和开始时间所属时区相同,TZ database name格式
非全天日程必须有值,全天日程必须留空。
isAllDay
boolean
是否为全天日程。
recurrence
object
日程循环规则。
pattern
object
重复模式。
range
object
循环范围。
attendees
array [object {4}]
参与人列表。
id
string
可选
用户的unionId。
displayName
string
用户名。
responseStatus
string
回复状态。
self
boolean
可选
是否是当前登陆用户。
organizer
object
组织者。
id
string
可选
组织者unionId。
displayName
string
用户名。
responseStatus
string
回复状态。
self
boolean
可选
是否是当前登陆用户。
location
object
日程地点相关信息。
displayName
string
日程地点名称。
seriesMasterId
string
可选
重复日程的主日程id,非重复日程为空。
createTime
string
创建时间。
updateTime
string
更新时间。
onlineMeetingInfo
object
线上会议。
type
string
可选
线上会议类型,目前支持:
conferenceId
string
会议ID。
url
string
参会的url地址。
extraInfo
object
其他扩展信息。
示例
{
"id": "string",
"summary": "string",
"description": "string",
"status": "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",
"onlineMeetingInfo": {
"type": "string",
"conferenceId": "string",
"url": "string",
"extraInfo": {}
}
}
最后修改时间: 2 年前