查询空间日程列表

请求方法

GET

请求地址

/open/api/v1/calendar/events/spaces/{spaceId}

请求path参数

参数名称	参数类型	是否必须	参数说明
spaceId	String	是	空间id。调用 空间管理-空间相关接口 查询空间id

请求query参数

参数名称	参数类型	是否必须	参数说明
startTime	Long	是	查询范围开始时间（毫秒时间戳）
endTime	Long	是	查询范围结束时间（毫秒时间戳）。endTime - startTime 小于一个月
pageToken	String	否	分页游标，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 pageToken，下次遍历可采用该 pageToken 获取查询结果
pageSize	Integer	否	最大返回记录数，最大值100，默认值100。

响应参数

参数名称	参数类型	参数说明
hasMore	Boolean	是否还有更多数据
pageToken	String	分页游标，当 hasMore = true 时，会同时返回新的 pageToken，否则 pageToken = 0
data	Event[]	日程列表

Event 对象

参数名称	参数类型	参数说明
eventId	String	日程id
summary	String	标题
organizer	Organizer	组织者信息
startTime	Long	开始时间（毫秒时间戳）
endTime	Long	结束时间（毫秒时间戳）
releaseTime	Long	释放时间（毫秒时间戳）
timezoneId	String	时区id
attendeeTotal	Integer	参与者总数
description	String	描述

Organizer 对象

参数名称	参数类型	参数说明
userId	String	用户id
userName	String	用户名称

请求消息示例

GET /open/api/v1/calendar/events/spaces/650786024848359429 HTTP/1.1
Host: smart.yealink.com
Content-Type: application/json

成功响应示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
    "hasMore": true,
    "pageToken": "59082022xxxxxxxxx",
    "data": [
        {
            "eventId": "590820226952593408",
            "summary": "日程主题XXX",
            "organizer": {
                "userId": "46d68543917b4e08b440e02628059880",
                "userName": "张三"
            },
            "startTime": 1710316800000,
            "endTime": 1710318600000,
            "releaseTime": 1710318600000,
            "timezoneId": "China_Standard_Time",
            "attendeeTotal": 5,
            "description": "日程描述XXXX"
        }
    ]
}

CURL命令实例

curl -X GET https://smart.yealink.com/open/api/v1/calendar/events/spaces/650786024848359429 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1CSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjoxMDAsImV4IjoxNTgzNzQ5OTQ3ODg2LCJ0IjoibyIsImNpIjoiMDgyOWI4Mjg3NjI3NDg2NDg5YzEwN2ViYzI0NGVmNjMiLCJwaWQiOiJhZThjZDNkNjNlYjU0OWM0YWNmMWJiOTdlOGEwMTkyMiIsImp0aSI6IjI1NmE5OTc5MWJkMDRlNDJhYWZhYzcyOWNkMzkxZDZjIn0.hDQCgrBTAZgYo8cKjfq5dZIc4C_Np0HTxwKuvmAu05awC-vdmopDQ67PXBJRDFihTLAhNBE-9oTF5_PmWhmERTrFaXPDp8bA9vetHP1JVuZK36J88EGgNE3thBoObLEGRyJASxP0BAe-tkXE-AXdRA08Bzolo27AIWVEAADb6Vk" -H "Content-Type: application/json" -H "timestamp: 1583742732181" -H "nonce: 53f0765fadb54fb6b002f3baac2d5ec8"

http状态码

返回值	描述
200	操作成功，详见响应参数
400	客户端传参异常
401	鉴权失败
500	服务端异常

NodeType节点类型

类型值	说明
root	根节点
country	国家
state	州/省
region	地区
park	园区
building	楼宇
floor	楼层
subarea	子区域

EventType日程类型

类型值	说明
once	单次
recurrence	周期
exception	特例