文档帮助平台
首页服务器API参考 日程管理 日程 创建日程
创建日程
更新时间：2025-04-10 12:15:47

创建日程

请求方法

POST

请求地址

/open/api/v1/calendar/events

请求body参数

参数名称 参数类型 是否必须 参数说明
summary String 是 标题，上限128个字符
startTime Long 是 开始时间（毫秒时间戳）
endTime Long 是 结束时间（毫秒时间戳）
timezoneId String 是 时区id。具体时区列表详见 用户中心-基础信息-查询时区列表接口
recurrence String 否 重复日程的重复规则，RRule规则参考 RRule说明
attendees Attendee[] 否 参与者信息列表，上限1000个。默认包含组织者
spaceIds String[] 是 空间id列表。可调用 空间管理-空间-查询空间列表接口 获取
attachments Attachment[] 否 附件信息列表，上限10个，总大小上限50MB
description String 否 描述，上限3000个字符
organizerId String 是 组织者Id。可调用 用户中心-企业成员管理-查询用户列表接口 获取用户id

Attendee 对象

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

Attachment 对象

参数名称 参数类型 是否必须 参数说明
fileId String 是 文件id。可调用获取文件上传url接口，获取文件上传url和文件id
fileName String 是 文件名
fileSizeBytes Long 是 文件大小，单位字节
order Integer 否 文件顺序

响应参数

参数名称 参数类型 参数说明
eventId String 日程id
summary String 标题
organizer Organizer 组织者信息
startTime Long 开始时间（毫秒时间戳）
endTime Long 结束时间（毫秒时间戳）
timezoneId String 时区id
eventType String 日程类型。详见 eventType日程类型
recurrence String 重复规则。RRule规则参考 RRule说明
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
fileName String 文件名
fileSizeBytes Long 文件大小，单位字节

请求消息示例

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

{
    "summary": "日程主题XXX",
    "startTime": 1710316800000,
    "endTime": 1710318600000,
    "timezoneId": "China_Standard_Time",
    "recurrence": "FREQ=WEEKLY;BYDAY=MO;INTERVAL=2;UNTIL=20240331T235959Z",
    "attendees": [
        {
            "attendeeType": "subject",
            "identifier": "uuid"
        }
    ],
    "spaceIds": [
        "591175861349122048"
    ],
    "attachments": [
        {
            "fileId": "3166bea1192a4bafb2e79a7b4da11a9e",
            "fileName": "XXX文件.pdf",
            "fileSizeBytes": 1024
        }
    ],
    "description": "日程描述XXXX",
    "organizerId": "46d68543917b4e08b440e02628059880"
}

成功响应示例

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

{
    "eventId": "590820226952593408",
    "summary": "日程主题XXX",
    "organizer": {
        "userId": "46d68543917b4e08b440e02628059880",
        "userName": "张三"
    },
    "startTime": 1710316800000,
    "endTime": 1710318600000,
    "timezoneId": "China_Standard_Time",
    "eventType": "recurrence",
    "recurrence": "FREQ=WEEKLY;BYDAY=MO;INTERVAL=2;UNTIL=20240331T235959Z",
    "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 POST https://smart.yealink.com/open/api/v1/calendar/events -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1CSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjoxMDAsImV4IjoxNTgzNzQ5OTQ3ODg2LCJ0IjoibyIsImNpIjoiMDgyOWI4Mjg3NjI3NDg2NDg5YzEwN2ViYzI0NGVmNjMiLCJwaWQiOiJhZThjZDNkNjNlYjU0OWM0YWNmMWJiOTdlOGEwMTkyMiIsImp0aSI6IjI1NmE5OTc5MWJkMDRlNDJhYWZhYzcyOWNkMzkxZDZjIn0.hDQCgrBTAZgYo8cKjfq5dZIc4C_Np0HTxwKuvmAu05awC-vdmopDQ67PXBJRDFihTLAhNBE-9oTF5_PmWhmERTrFaXPDp8bA9vetHP1JVuZK36J88EGgNE3thBoObLEGRyJASxP0BAe-tkXE-AXdRA08Bzolo27AIWVEAADb6Vk" -H "Content-Type: application/json" -H "timestamp: 1583742732181" -H "nonce: 53f0765fadb54fb6b002f3baac2d5ec8" -d '{"summary": "日程主题XXX","startTime": 1710316800000,"endTime": 1710318600000,"timezoneId": "China_Standard_Time","recurrence": "FREQ=WEEKLY;BYDAY=MO;INTERVAL=2;UNTIL=20240331T235959Z","attendees": [{"attendeeType": "subject","identifier": "uuid"}],"spaceIds": ["591175861349122048"],"attachments": [{"fileId": "3166bea1192a4bafb2e79a7b4da11a9e","fileName": "XXX文件.pdf","fileSizeBytes": 1024}],"description": "日程描述XXXX","organizerId": "46d68543917b4e08b440e02628059880"}'

http状态码

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

业务错误码

错误码 错误信息 说明
901408 space.resource.conflict 会议室预约时间段已被占用
901512 space.not.match.schedule.strategy 不满足空间预约策略

AttendeeType参与者类型

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

EventType日程类型

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

NodeType节点类型

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