Skip to content

查看日程忙闲

适用版本 >=v7.0.2411b.20241128

接口说明:查看日程忙闲, 查询时间需要满足 end_time-start_time <= 7 天

标签日程忙闲

请求说明

字段
请求地址
配置域名+/openapi+/v7/free_busy_list
HTTP 方法
GET
接口描述
查看日程忙闲, 查询时间需要满足 end_time-start_time <= 7 天
签名方式
KSO-1(配置域名+/openapi不参与签名)
限频策略
权限要求
查询日程信息(应用授权) kso.calendar_events.read
查询和管理日程信息(应用授权) kso.calendar_events.readwrite
查询日程信息(用户授权) kso.calendar_events.read
查询和管理日程信息(用户授权) kso.calendar_events.readwrite
使用MCP日程能力(用户授权) kso.mcp_calendar.readwrite
使用MCP场景化服务能力(用户授权) kso.mcp_scenario.readwrite

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

查询参数 (Query)

属性名类型是否必填描述可选值
start_time
string开始查询时间,需要url编码,RFC3339格式,例如:2024-01-15T14%3A30%3A00%2B08%3A00-
end_time
string结束查询时间,需要url编码,RFC3339格式,例如:2024-01-15T14%3A30%3A00%2B08%3A00-
user_ids
array用户id列表,可从通讯录接口获取,用于查询指定用户的忙闲状态。最大数量50-
room_ids
array会议室id列表,可从会议室列表接口获取。最大数量50-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

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