查询日程详情

请求方法

GET

请求地址

/open/api/v1/calendar/events/{eventId}

请求path参数

参数名称	参数类型	是否必须	参数说明
eventId	String	是	日程id

响应参数

参数名称	参数类型	参数说明
eventId	String	日程id
summary	String	标题
organizer	Organizer	组织者信息
startTime	Long	开始时间（毫秒时间戳）
endTime	Long	结束时间（毫秒时间戳）
timezoneId	String	时区id
eventType	String	日程类型。详见 eventType日程类型
recurrence	String	重复规则。RRule规则参考 RRule说明
originalEventId	String	原周期日程id
attendees	Attendee[]	参与者列表
spaces	Space[]	空间信息列表
attachments	Attachment[]	附件信息列表
description	String	描述

Organizer 对象

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

Attendee 对象

参数名称	参数类型	是否必须	参数说明
attendeeType	String	是	参与者类型。详见 attendeeType参与者类型
identifier	String	是	参与者标识。attendeeType = subject时值为用户id，attendeeType = email时值为邮箱地址

Space 对象

参数名称	参数类型	参数说明
spaceId	String	空间id
spaceName	String	空间名称
locations	Location[]	空间所属区域信息

Location 对象

参数名称	参数类型	参数说明
locationType	String	区域类型 nodeType节点类型
locationName	String	区域名称

Attachment 对象

参数名称	参数类型	参数说明
fileId	String	文件id。可调用获取文件下载url接口，获取文件下载url
fileName	String	文件名
fileSizeBytes	Long	文件大小，单位字节

请求消息示例

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

成功响应示例

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

{
    "eventId": "590820226952593408",
    "summary": "日程主题XXX",
    "organizer": {
        "userId": "46d68543917b4e08b440e02628059880",
        "userName": "张三"
    },
    "startTime": 1710316800000,
    "endTime": 1710318600000,
    "eventType": "recurrence",
    "recurrence": "FREQ=WEEKLY;BYDAY=MO;INTERVAL=2;UNTIL=20240331T235959Z",
    "originalEventId": null,
    "timezoneId": "China_Standard_Time",
    "attendees": [
        {
            "attendeeType": "subject",
            "identifier": "uuid"
        }
    ],
    "spaces": [
        {
            "spaceId": "591175861349122048",
            "spaceName": "办公楼-10楼-XX会议室",
            "locations": [
                {
                    "locationType": "building",
                    "locationName": "A楼"
                },
                {
                    "locationType": "floor",
                    "locationName": "9层"
                }
            ]
        }
    ],
    "attachments": [
        {
            "fileId": "3166bea1192a4bafb2e79a7b4da11a9e",
            "fileName": "XXX文件.pdf",
            "fileSizeBytes": 1024
        }
    ],
    "description": "日程描述XXXX"
}

CURL命令实例

curl -X GET https://smart.yealink.com/open/api/v1/calendar/events/590820226952593408 -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	特例

AttendeeType参与者类型

类型值	说明
subject	企业成员
email	邮箱