文档中心 > API类目 > 钉钉API

dingtalk.oapi.calendar.v2.event.create (日程2.0创建接口)

通过此接口可以创建钉钉日程，在对应的日历中展示

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	描述
event	Event	必须		日程创建对象
attendees Attendee [] 必须日程参与者，参与者最大人数为100(包括组织者) └ userid String 必须 manager8037 员工工号 └ calendar_id String 必须 primary 目前只能传primary，表示创建的日程在“我的日程”下 └ description String 可选请积极发言日程描述 end DateTime 必须结束时间 └ date String 可选 2019-09-15 日期，全天日程使用，格式必须为'yyyy-mm-dd',和timestamp字段互斥，该字段有值时，则忽略timestamp字段 └ timestamp Number 可选 1570781196 时间戳，单位为秒。非全天日程使用，与date字段互斥 └ timezone String 可选 Asia/Shanghai 时区信息，默认为"Asia/Shanghai"。date有值时，timezone 为 UTC； organizer Attendee 必须日程组织者 └ userid String 可选 manager8037 员工工号 start DateTime 必须开始时间 └ date String 可选 2019-09-15 日期，全天日程使用，格式必须为'yyyy-mm-dd',和timestamp字段互斥，该字段有值时，则忽略timestamp字段 └ timestamp Number 可选 1570781196 时间戳，单位为秒。非全天日程使用，与date字段互斥 └ timezone String 可选 Asia/Shanghai 时区信息，默认为"Asia/Shanghai"。date有值时，timezone 为 UTC； └ summary String 必须晨会日程主题 reminder OpenCalendarReminderVo 可选会议开始前多少分钟提醒 └ method String 可选 app 提醒方式.app表示应用内提醒 └ minutes Number 可选 0 开始前提醒的分钟数,有效值为0，5，15，30，60，1440 location LocationVo 可选地址信息 └ latitude String 可选 30.285228 纬度 └ longitude String 可选 120.017022 经度 └ place String 可选未来park 地址详情 └ notification_type String 可选 NONE 受限字段,仅支持传NONE或者APP
agentid	Number	可选	1212	开放平台应用对应的AgentId

响应参数

名称	类型	示例值	描述
result	Event		日程对象
attendees Attendee [] 日程参与者 └ userid String manager8037 员工工号 └ calendar_id String primary primary表示创建的日程在“我的日程”下 └ description String 请积极发言日程描述 end DateTime 结束时间 └ date String 2019-09-15 日期，全天日程使用，格式必须为'yyyy-mm-dd',和timestamp字段互斥，该字段有值时，则忽略timestamp字段 └ timestamp Number 1570781196 时间戳，单位为秒。非全天日程使用，与date字段互斥 └ timezone String Asia/Shanghai 时区信息，默认为"Asia/Shanghai"。date有值时，timezone 为 UTC； └ event_id String 111 日程id organizer Attendee 日程组织者 └ userid String manager8037 员工工号 start DateTime 开始时间 └ date String 2019-09-15 日期，全天日程使用，格式必须为'yyyy-mm-dd',和timestamp字段互斥，该字段有值时，则忽略timestamp字段 └ timestamp Number 1570781196 时间戳，单位为秒。非全天日程使用，与date字段互斥 └ timezone String Asia/Shanghai 时区信息，默认为"Asia/Shanghai"。date有值时，timezone 为 UTC； └ summary String 晨会日程主题 reminder OpenCalendarReminderVo 会议开始前提醒 └ method String 提醒方式.app表示应用内提醒 └ minutes Number 会议开始前多少分钟提醒 location LocationVo 地址 └ latitude String 30.285228 纬度 └ longitude String 120.285228 经度 └ place String 未来park 地址 └ notification_type String NONE 提醒方式
success	Boolean	true	结果是否正确
errcode	Number	0	错误编码
errmsg	String	接收人不能为空	错误信息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/calendar/v2/event/create");
OapiCalendarV2EventCreateRequest req = new OapiCalendarV2EventCreateRequest();
Event obj1 = new Event();
List<Attendee> list3 = new ArrayList<Attendee>();
Attendee obj4 = new Attendee();
list3.add(obj4);
obj4.setUserid("manager8037");
obj1.setAttendees(list3);
obj1.setCalendarId("primary");
obj1.setDescription("请积极发言");
DateTime obj5 = new DateTime();
obj5.setDate("2019-09-15");
obj5.setTimestamp(1570781196L);
obj5.setTimezone("Asia/Shanghai");
obj1.setEnd(obj5);
Attendee obj6 = new Attendee();
obj6.setUserid("manager8037");
obj1.setOrganizer(obj6);
DateTime obj7 = new DateTime();
obj7.setDate("2019-09-15");
obj7.setTimestamp(1570781196L);
obj7.setTimezone("Asia/Shanghai");
obj1.setStart(obj7);
obj1.setSummary("晨会");
OpenCalendarReminderVo obj8 = new OpenCalendarReminderVo();
obj8.setMethod("app");
obj8.setMinutes(0L);
obj1.setReminder(obj8);
LocationVo obj9 = new LocationVo();
obj9.setLatitude("30.285228");
obj9.setLongitude("120.017022");
obj9.setPlace("未来park");
obj1.setLocation(obj9);
obj1.setNotificationType("NONE");
req.setEvent(obj1);
req.setAgentid(1212L);
OapiCalendarV2EventCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/calendar/v2/event/create");
OapiCalendarV2EventCreateRequest req = new OapiCalendarV2EventCreateRequest();
OapiCalendarV2EventCreateRequest.EventDomain obj1 = new OapiCalendarV2EventCreateRequest.EventDomain();
List<OapiCalendarV2EventCreateRequest.AttendeeDomain> list3 = new List<OapiCalendarV2EventCreateRequest.AttendeeDomain>();
OapiCalendarV2EventCreateRequest.AttendeeDomain obj4 = new OapiCalendarV2EventCreateRequest.AttendeeDomain();
list3.Add(obj4);
obj4.Userid = "manager8037";
obj1.Attendees= list3;
obj1.CalendarId = "primary";
obj1.Description = "请积极发言";
OapiCalendarV2EventCreateRequest.DateTimeDomain obj5 = new OapiCalendarV2EventCreateRequest.DateTimeDomain();
obj5.Date = "2019-09-15";
obj5.Timestamp = 1570781196L;
obj5.Timezone = "Asia/Shanghai";
obj1.End= obj5;
OapiCalendarV2EventCreateRequest.AttendeeDomain obj6 = new OapiCalendarV2EventCreateRequest.AttendeeDomain();
obj6.Userid = "manager8037";
obj1.Organizer= obj6;
OapiCalendarV2EventCreateRequest.DateTimeDomain obj7 = new OapiCalendarV2EventCreateRequest.DateTimeDomain();
obj7.Date = "2019-09-15";
obj7.Timestamp = 1570781196L;
obj7.Timezone = "Asia/Shanghai";
obj1.Start= obj7;
obj1.Summary = "晨会";
OapiCalendarV2EventCreateRequest.OpenCalendarReminderVoDomain obj8 = new OapiCalendarV2EventCreateRequest.OpenCalendarReminderVoDomain();
obj8.Method = "app";
obj8.Minutes = 0L;
obj1.Reminder= obj8;
OapiCalendarV2EventCreateRequest.LocationVoDomain obj9 = new OapiCalendarV2EventCreateRequest.LocationVoDomain();
obj9.Latitude = "30.285228";
obj9.Longitude = "120.017022";
obj9.Place = "未来park";
obj1.Location= obj9;
obj1.NotificationType = "NONE";
req.Event_ = obj1;
req.Agentid = 1212L;
OapiCalendarV2EventCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiCalendarV2EventCreateRequest;
$event = new Event;
$attendees = new Attendee;
$attendees->userid="manager8037";
$event->attendees = array($attendees);
$event->calendar_id="primary";
$event->description="请积极发言";
$end = new DateTime;
$end->date="2019-09-15";
$end->timestamp="1570781196";
$end->timezone="Asia/Shanghai";
$event->end = $end;
$organizer = new Attendee;
$organizer->userid="manager8037";
$event->organizer = $organizer;
$start = new DateTime;
$start->date="2019-09-15";
$start->timestamp="1570781196";
$start->timezone="Asia/Shanghai";
$event->start = $start;
$event->summary="晨会";
$reminder = new OpenCalendarReminderVo;
$reminder->method="app";
$reminder->minutes="0";
$event->reminder = $reminder;
$location = new LocationVo;
$location->latitude="30.285228";
$location->longitude="120.017022";
$location->place="未来park";
$event->location = $location;
$event->notification_type="NONE";
$req->setEvent($event);
$req->setAgentid("1212");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/calendar/v2/event/create");

curl -X POST "https://oapi.dingtalk.com/topapi/calendar/v2/event/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c0a9b17e-b417-4474-a03f-a1191d9e2c2d' \
-d 'agentid=1212' \
-d 'event=null'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiCalendarV2EventCreateRequest("https://oapi.dingtalk.com/topapi/calendar/v2/event/create")

req.event=""
req.agentid=1212
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.calendar.v2.event.create");
add_param(pRequest,"event","数据结构JSON示例");
add_param(pRequest,"agentid","1212");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.calendar.v2.event.create', {
	'event':'数据结构JSON示例',
	'agentid':'1212'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "attendees":[
            {
                    "userid":"manager8037"
            }
        ],
        "calendar_id":"primary",
        "description":"请积极发言",
        "end":{
            "date":"2019-09-15",
            "timestamp":1570781196,
            "timezone":"Asia\/Shanghai"
        },
        "event_id":"111",
        "organizer":{
            "userid":"manager8037"
        },
        "start":{
            "date":"2019-09-15",
            "timestamp":1570781196,
            "timezone":"Asia\/Shanghai"
        },
        "summary":"晨会",
        "reminder":{
            "method":"",
            "minutes":
        },
        "location":{
            "latitude":"30.285228",
            "longitude":"120.285228",
            "place":"未来park"
        },
        "notification_type":"NONE"
    },
    "success":true,
    "errcode":0,
    "errmsg":"接收人不能为空"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.calendar.v2.event.create (日程2.0创建接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ