批量查询会议室预约
批量查询会议室预约
请求说明
请求地址 | https://openapi.wps.cn/v7/meeting_room_bookings/batch_get |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询会议室(应用授权) kso.meeting_rooms.read 查询和管理会议室(应用授权) kso.meeting_rooms.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} |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
end_time | integer | 是 | 结束时间 Unix 时间戳 秒数 |
include_deleted | boolean | 否 | 是否包含已删除的预约,默认不包含 (false) |
page_size | integer | 否 | 每页数量,默认 20 |
page_token | string | 否 | 分页凭证 |
results | array[string] | 否 | 预约结果列表,可指定多个预约结果进行筛选,默认预约成功 |
room_ids | array[string] | 否 | 会议室 id 列表(和 room_level_id 二选一) |
room_level_id | string | 否 | 会议室层级 id(和 room_ids 二选一) |
start_time | integer | 是 | 开始时间 Unix 时间戳 秒数 |
请求地址示例
[POST] https://openapi.wps.cn/v7/meeting_room_bookings/batch_get
请求体示例
json
{
"end_time": 0,
"include_deleted": false,
"page_size": 0,
"page_token": "string",
"results": [
"string"
],
"room_ids": [
"string"
],
"room_level_id": "string",
"start_time": 0
}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ items | array[object] | 预约信息列表 |
∟ ∟ accept_count | integer | 接受邀约人数 |
∟ ∟ calendar_id | string | 日历 id |
∟ ∟ create_time | integer | 预约日程的创建时间 Unix 时间戳 毫秒级 |
∟ ∟ delete_time | integer | 删除时间 Unix 时间戳 毫秒级 |
∟ ∟ dept_name | string | 预定人所属部门 |
∟ ∟ end_time | integer | 预约结束时间 Unix 时间戳 毫秒级 |
∟ ∟ event_id | string | 日程 id |
∟ ∟ failed_reason | string | 预约会议室失败原因 |
∟ ∟ id | string | 会议室预约 id |
∟ ∟ invite_count | integer | 邀约人数 |
∟ ∟ is_recurring | boolean | 是否重复日程 |
∟ ∟ result | string[enum] | 预约结果 success ;failed ;approving |
∟ ∟ room_id | string | 会议室 id |
∟ ∟ room_name | string | 会议室名称 |
∟ ∟ sign_in_status | string[enum] | 会议室签到状态 wait ;success ;release |
∟ ∟ sign_time | integer | 会议室签到时间 Unix 时间戳 毫秒级 |
∟ ∟ start_time | integer | 预约开始时间,最大查询时长 14 天 Unix 时间戳 毫秒级 |
∟ ∟ summary | string | 主题 |
∟ ∟ user | object | 预约人信息 |
∟ ∟ ∟ id | string | 用户 id |
∟ ∟ ∟ user_name | string | 用户姓名 |
∟ next_page_token | string | 下一页凭证,该参数不存在或为空串时表示没有下一页 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"items": [
{
"accept_count": 0,
"calendar_id": "string",
"create_time": 0,
"delete_time": 0,
"dept_name": "string",
"end_time": 0,
"event_id": "string",
"failed_reason": "string",
"id": "string",
"invite_count": 0,
"is_recurring": false,
"result": "string[enum]",
"room_id": "string",
"room_name": "string",
"sign_in_status": "string[enum]",
"sign_time": 0,
"start_time": 0,
"summary": "string",
"user": {
"id": "string",
"user_name": "string"
}
}
],
"next_page_token": "string"
},
"msg": "string"
}