创建日程

说明

调用本接口创建一个日程。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	日历应用中日程写权限	API Explorer
第三方企业应用	暂不支持	日历应用中日程写权限	暂不支持
第三方个人应用	支持	日历应用中日程写权限	API Explorer

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter	forwardErrorMessage	参数异常
404	itemNotFound	forwardErrorMessage	无法找到指定日程

请求参数

Path 参数

userId

string

必需

日程组织者的unionId，可通过根据userid获取用户详情接口获取。

calendarId

string

必需

日程所属的日历ID，统一为primary，表示用户的主日历。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用服务端接口的授权凭证。

Body 参数application/json

summary

string

日程标题。

必需

description

string

日程描述。

可选

start

object

日程开始时间。

必需

date

string

可选

日程开始日期，格式：yyyy-MM-dd。
如果是全天日程必须有值，非全天日程必须留空。

dateTime

string

可选

日程开始时间，格式为ISO-8601的date-time格式。
非全天日程必须有值，全天日程必须留空。

timeZone

string

可选

日程开始时间所属时区，TZ database name格式。
非全天日程必须有值，全天日程必须留空。

end

object

日程结束时间。

可选

date

string

可选

日程结束日期，格式：yyyy-MM-dd。
如果是全天日程必须有值，非全天日程必须留空。

dateTime

string

可选

日程结束时间，格式为ISO-8601的date-time格式。
非全天日程必须有值，全天日程必须留空。

timeZone

string

可选

日程结束时间所属时区，必须和开始时间所属时区相同，TZ database name格式。
非全天日程必须有值，全天日程必须留空。

isAllDay

boolean

是否全天日程。

可选

recurrence

object

日程循环规则。

可选

pattern

object

循环规则。

可选

range

object

循环范围。

可选

attendees

array [object {1}]

可选

日程参与人列表，最多支持500个参与人。

string

可选

用户的unionId，可通过根据userid获取用户详情接口获取。

location

object

日程地点。

可选

displayName

string

日程地点的名称。

可选

reminders

array [object {2}]

可选

日程提醒，可以添加多个，如果不传默认提醒时间为：
如果传空数据表示不创建任何提醒。

method

string

提醒方式：

可选

minutes

integer

可选

在日程开始前N分钟发出提醒。

onlineMeetingInfo

object

可选

创建日程同时创建线上会议。

type

string

线上会议类型：

可选

extra

object

可选

JSON格式的扩展能力开关，选填，具体属性定义如下：

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

string

日程ID。

可选

summary

string

日程标题。

可选

description

string

日程描述。

可选

start

object

日程开始时间。

可选

date

string

可选

日程开始日期，格式：yyyy-MM-dd。
如果是全天日程必须有值，非全天日程必须留空。

dateTime

string

可选

日程开始时间，格式为ISO-8601的date-time格式。
非全天日程必须有值，全天日程必须留空。

timeZone

string

可选

日程开始时间所属时区，TZ database name格式
非全天日程必须有值，全天日程必须留空。

end

object

日程结束时间。

可选

date

string

可选

日程结束日期，格式：yyyy-MM-dd。
如果是全天日程必须有值，非全天日程必须留空。

dateTime

string

可选

日程结束时间，格式为ISO-8601的date-time格式。
非全天日程必须有值，全天日程必须留空。

timeZone

string

可选

日程结束时间所属时区，必须和开始时间所属时区相同，TZ database name格式。
非全天日程必须有值，全天日程必须留空。

isAllDay

boolean

是否全天日程。

可选

recurrence

object

日程循环规则。

可选

pattern

object

循环规则。

可选

range

object

循环范围。

可选

attendees

array [object {4}]

参与人列表。

可选

string

可选

用户的unionId。

displayName

string

用户姓名。

可选

responseStatus

string

参会人状态：

可选

self

boolean

是否当前操作用户。

可选

organizer

object

日程组织者。

可选

string

可选

用户的unionId。

displayName

string

用户名。

可选

responseStatus

string

回复状态。

可选

self

boolean

是否当前用户。

可选

location

object

日程地点。

可选

displayName

string

地点名称。

可选

reminders

array [object {2}]

日程提醒。

可选

method

string

提醒方式：

可选

minutes

string

可选

提前多久提醒，单位分钟。

createTime

string

创建时间。

可选

updateTime

string

更新时间。

可选

onlineMeetingInfo

object

线上会议信息。

可选

type

string

线上会议类型：

可选

conferenceId

string

会议id。

可选

url

string

参会url。

可选

extraInfo

object

其他扩展信息。

可选

示例

{
  "id": "string",
  "summary": "string",
  "description": "string",
  "start": {
    "date": "string",
    "dateTime": "string",
    "timeZone": "string"
  },
  "end": {
    "date": "string",
    "dateTime": "string",
    "timeZone": "string"
  },
  "isAllDay": true,
  "recurrence": {
    "pattern": {
      "type": "string",
      "dayOfMonth": 0,
      "daysOfWeek": "string",
      "index": "string",
      "interval": 0
    },
    "range": {
      "type": "string",
      "endDate": "string",
      "numberOfOccurrences": 0
    }
  },
  "attendees": [
    {
      "id": "string",
      "displayName": "string",
      "responseStatus": "string",
      "self": true
    }
  ],
  "organizer": {
    "id": "string",
    "displayName": "string",
    "responseStatus": "string",
    "self": true
  },
  "location": {
    "displayName": "string"
  },
  "reminders": [
    {
      "method": "string",
      "minutes": "string"
    }
  ],
  "createTime": "string",
  "updateTime": "string",
  "onlineMeetingInfo": {
    "type": "string",
    "conferenceId": "string",
    "url": "string",
    "extraInfo": {}
  }
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码