查看日程忙闲
查看日程忙闲, 查询时间需要满足 end_time-start_time <= 7 天
请求说明
请求地址 | https://openapi.wps.cn/v7/free_busy_list |
---|---|
请求方法 | GET |
签名方式 | KSO-1 |
权限要求 | 查询日程(用户授权) kso.calendar_events.read 查询和管理日程信息(用户授权) kso.calendar_events.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
查询参数(Query)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
end_time | string | 是 | 结束查询时间,需要 url 编码 |
room_ids | array | 否 | 会议室 id,meeting_room.id |
start_time | string | 是 | 开始查询时间,需要 url 编码 |
user_ids | array | 否 | 用户 id,user.id |
请求地址示例
[GET] https://openapi.wps.cn/v7/free_busy_list?end_time={string}&room_ids={array_1}&room_ids={array_2}&start_time={string}&user_ids={array_1}&user_ids={array_2}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ items | array[object] | |
∟ ∟ busy_times | array[object] | 忙时间 |
∟ ∟ ∟ end | string | 结束时间 |
∟ ∟ ∟ start | string | 开始时间 |
∟ ∟ room_id | string | 会议室 id, meeting_room.id |
∟ ∟ user_id | string | 用户 id, user.id |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"items": [
{
"busy_times": [
{
"end": "string",
"start": "string"
}
],
"room_id": "string",
"user_id": "string"
}
]
},
"msg": "string"
}