创建日程

说明

调用创建日程接口可以将企业员工的待办事项写入到钉钉日历并在钉钉日历中展示。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

错误码

错误码	说明	解决方案
856010	必填项错误	请仔细检查遗漏参数。
856011	格式化全天日程失败	全天日程格式必须为“yyyy-mm-dd”。
856012	开始结束日期不匹配。例如：开始日期是全天格式，但是结束日期不是全天格式	请检查开始时间和结束时间是否匹配，请求参数date和timestamp互斥。
856013	开始日期大于结束日期	请检查设置的开始时间和结束时间。
856014	开始时间等于结束时间	请检查设置的开始时间和结束时间。
856015	非法的event_id	请检查event_id是否正确。
856016	非法的app_id	请检查app_id是否正确，可以在开发者后台的应用详情页面查看。
856017	非法的userid	请检查userid是否正确，可以通过调用获取部门用户userid列表接口获取用户userid。
856018	非法的agentId	检查agentid字段是否为空，是否真实存在。
856019	获取open senderId异常	请使用应用的Appkey和AppSecret获取access_token，再次发送请求。

请求参数

Query 参数

access_token

string

必需

调用服务端接口的授权凭证。企业内部应用可通过调用access_token接口获得。

示例值:

6d1bxxxx

Body 参数application/json

event

object

日程创建对象。

必需

attendees

array [object {1}]

必需

日程参与者，参与者最大人数为100，包括组织者。

calendar_id

string

必需

目前只能传primary，表示创建的日程在“我的日程”下。

description

string

日程描述。

可选

end

object

结束时间。

必需

organizer

object

日程组织者信息。

必需

start

object

开始时间。

必需

summary

string

日程主题。

必需

reminder

object

会议开始前提醒。

可选

location

object

地址信息。

可选

notification_type

string

可选

受限字段，仅支持传NONE或者APP。

agentid

number

必需

应用对应的AgentId。

示例

{
  "agentid": "923680251",
  "event": {
    "summary": "夕会",
    "notification_type": "NONE",
    "calendar_id": "primary",
    "description": "这是一个测试的日程啊",
    "reminder": {
      "method": "app",
      "minutes": "5"
    },
    "attendees": [
      {
        "userid": "user123"
      },
      {
        "userid": "user456"
      }
    ],
    "organizer": {
      "userid": "user456"
    },
    "start": {
      "timezone": "Asia/Shanghai",
      "timestamp": "1605696900"
    },
    "end": {
      "timezone": "Asia/Shanghai",
      "timestamp": "1605709800"
    },
    "location": {
      "latitude": "30.285228",
      "place": "未来park",
      "longitude": "120.017022"
    }
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

result

object

日程对象。

可选

attendees

array [object {1}]

日程参与者。

可选

calendar_id

string

可选

primary表示创建的日程在“我的日程”下。

description

string

日程描述。

可选

end

object

结束时间。

可选

event_id

string

日程ID。

可选

organizer

object

日程组织者信息。

可选

start

object

开始时间。

可选

summary

string

日程主题。

可选

reminder

object

会议开始前提醒。

可选

location

object

地址。

可选

notification_type

string

提醒方式。

可选

success

boolean

是否成功。

可选

errcode

number

返回码。

可选

request_id

string

请求ID。

可选

errmsg

string

返回的错误信息。

可选

示例

{
  "result": {
    "attendees": [
      {
        "userid": "string"
      }
    ],
    "calendar_id": "string",
    "description": "string",
    "end": {
      "date": "string",
      "timestamp": 0,
      "timezone": "string"
    },
    "event_id": "string",
    "organizer": {
      "userid": "string"
    },
    "start": {
      "date": "string",
      "timestamp": 0,
      "timezone": "string"
    },
    "summary": "string",
    "reminder": {
      "method": "string",
      "minutes": 0
    },
    "location": {
      "latitude": "string",
      "longitude": "string",
      "place": "string"
    },
    "notification_type": "string"
  },
  "success": true,
  "errcode": 0,
  "request_id": "string",
  "errmsg": "string"
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码