获取用户忙闲信息
POST
/v1.0/calendar/users/{userId}/querySchedule最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口查询指定用户列表在指定时间内的忙闲信息。
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 日历应用中日程闲忙状态读权限 | API Explorer |
第三方企业应用 | 暂不支持 | 日历应用中日程闲忙状态读权限 | 暂不支持 |
第三方个人应用 | 支持 | 日历应用中日程闲忙状态读权限 | API Explorer |
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | paramIllegal | PARAM ILLEGAL | 参数异常 |
请求参数
Path 参数
userId
string
必需
本次请求的资源所归属的用户unionId,可通过根据userid获取用户详情接口获取。
Header 参数
x-acs-dingtalk-access-token
string
必需
调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。
Body 参数application/json
userIds
array[string]
必需
查询目标用户的unionId,可通过根据userid获取用户详情接口获取。
startTime
string
查询的开始时间。
endTime
string
查询的结束时间。
示例
{}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
scheduleInformation
array [object {3}]
用户忙闲信息。
userId
string
可选
查询目标用户的unionId。
error
string
异常信息。
scheduleItems
array [object {3}]
忙闲信息列表。
示例
{
"scheduleInformation": [
{
"userId": "string",
"error": "string",
"scheduleItems": [
{
"status": "string",
"start": {
"date": "string",
"dateTime": "string",
"timeZone": "string"
},
"end": {
"date": "string",
"dateTime": "string",
"timeZone": "string"
}
}
]
}
]
}
最后修改时间: 2 年前