Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

批量查询会议室预约

批量查询会议室预约

请求说明

请求地址https://openapi.wps.cn/v7/meeting_room_bookings/batch_get
请求方法POST
签名方式KSO-1
权限要求查询会议室(应用授权) kso.meeting_rooms.read
查询和管理会议室(应用授权) kso.meeting_rooms.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称参数类型是否必填说明
end_timeinteger结束时间 Unix 时间戳 秒数
include_deletedboolean是否包含已删除的预约,默认不包含 (false)
page_sizeinteger每页数量,默认 20
page_tokenstring分页凭证
resultsarray[string]预约结果列表,可指定多个预约结果进行筛选,默认预约成功
room_idsarray[string]会议室 id 列表(和 room_level_id 二选一)
room_level_idstring会议室层级 id(和 room_ids 二选一)
start_timeinteger开始时间 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
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]预约信息列表
∟ ∟ accept_countinteger接受邀约人数
∟ ∟ calendar_idstring日历 id
∟ ∟ create_timeinteger预约日程的创建时间 Unix 时间戳 毫秒级
∟ ∟ delete_timeinteger删除时间 Unix 时间戳 毫秒级
∟ ∟ dept_namestring预定人所属部门
∟ ∟ end_timeinteger预约结束时间 Unix 时间戳 毫秒级
∟ ∟ event_idstring日程 id
∟ ∟ failed_reasonstring预约会议室失败原因
∟ ∟ idstring会议室预约 id
∟ ∟ invite_countinteger邀约人数
∟ ∟ is_recurringboolean是否重复日程
∟ ∟ resultstring[enum]预约结果
successfailedapproving
∟ ∟ room_idstring会议室 id
∟ ∟ room_namestring会议室名称
∟ ∟ sign_in_statusstring[enum]会议室签到状态
waitsuccessrelease
∟ ∟ sign_timeinteger会议室签到时间 Unix 时间戳 毫秒级
∟ ∟ start_timeinteger预约开始时间,最大查询时长 14 天 Unix 时间戳 毫秒级
∟ ∟ summarystring主题
∟ ∟ userobject预约人信息
∟ ∟ ∟ idstring用户 id
∟ ∟ ∟ user_namestring用户姓名
∟ next_page_tokenstring下一页凭证,该参数不存在或为空串时表示没有下一页
moreobject更多的错误信息

响应体示例

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"
}
回到旧版