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

查看日程忙闲

查看日程忙闲, 查询时间需要满足 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-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
end_timestring结束查询时间,需要 url 编码
room_idsarray会议室 id,meeting_room.id
start_timestring开始查询时间,需要 url 编码
user_idsarray用户 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}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]
∟ ∟ busy_timesarray[object]忙时间
∟ ∟ ∟ endstring结束时间
∟ ∟ ∟ startstring开始时间
∟ ∟ room_idstring会议室 id, meeting_room.id
∟ ∟ user_idstring用户 id, user.id
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "busy_times": [
          {
            "end": "string",
            "start": "string"
          }
        ],
        "room_id": "string",
        "user_id": "string"
      }
    ]
  },
  "msg": "string"
}
回到旧版