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

dingtalk.oapi.calendar.list (日程查询)

该api是提供给企业和isv用的，查询企业内员工的日程数据。

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	描述
calendar_folder_id	String	可选	1k3io5atbqjbgh9927j8d94abh	钉钉日历文件夹的对外id，默认是自己的默认文件夹
time_min	DateTime	可选		查询时间下限
└ date_time String 可选 2019-03-01T23:08:53+0800 时间 'yyyy-MM-ddTHH:mm:ssZ', └ time_zone String 可选 Asia/Shanghai 时区
user_id	String	必须	123134568	员工ID
single_events	Boolean	可选	false	是否需要展开循环日程
page_token	String	可选	CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI	查询对应页，值有上一次请求返回的结果里对应nextPageToken
max_results	Number	可选	300	结果返回的最多数量，默认250，最多返回2500
time_max	DateTime	可选		查询时间上限
└ date_time String 可选 2019-03-01T23:08:53+0800 时间 'yyyy-MM-ddTHH:mm:ssZ', └ time_zone String 可选 Asia/Shanghai 时区

响应参数

名称	类型	示例值	描述
result	OpenCalendarListResponse	OpenCalendarListResponse	api返回的结果对象
└ summary String 李四的日程文件夹描述 items Items [] CalendarItem 日程的实体 └ unique_id String k3io5atbqjbgh9927j8d94abh 日程的唯一ID, 周期日程的所有序列的unique_id为同一个 └ recurrence_id String 1609466400000 循环日程中对应的序列id organizer User User 组织者 └ self Boolean true 是否自己 └ display_name String 张三展示姓名 └ userid String 12323 员工id └ recurrence String [] YEARLY;INTERVAL=2;BYMONTH=1;BYDAY=SU;BYHOUR=8,9（RFC5545 see link https://tools.ietf.org/html/rfc5545#section-3.8.5）循环的规则 end DateTime DateTime 结束时间 └ date String 2018-08-08 全天事件的时候使用 yyyy-MM-dd（date_time和date不可以同时出现） └ time_zone String Asia/Shanghai 时区 └ date_time String 2019-03-01T23:08:53+0800 时间 'yyyy-MM-ddTHH:mm:ssZ', start DateTime DateTime 开始时间 └ date String 2018-08-08 全天事件的时候使用 yyyy-MM-dd（date_time和date不可以同时出现） └ time_zone String Asia/Shanghai 时区 └ date_time String 2019-03-01T23:08:53+0800 时间 'yyyy-MM-ddTHH:mm:ssZ', └ location String 第三会议室地点 └ description String 今天下午在xx会见xx 内容描述 └ summary String 日程标题（生日）标题简述 updated DateTime DateTime 最后一次更新时间 └ date String 2018-08-08 全天事件的时候使用 yyyy-MM-dd（date_time和date不可以同时出现） └ time_zone String Asia/Shanghai 时区 └ date_time String 2019-03-01T23:08:53+0800 时间 'yyyy-MM-ddTHH:mm:ssZ', created DateTime DateTime 创建时间 └ date String 2018-08-08 全天事件的时候使用 yyyy-MM-dd（date_time和date不可以同时出现） └ time_zone String Asia/Shanghai 时区 └ date_time String 2019-03-01T23:08:53+0800 时间 'yyyy-MM-ddTHH:mm:ssZ', └ status String confirmed 状态（confirmed、cancelled） └ id String 1k3io5atbqjbgh9927j8d94abh 日程事件id └ response_status String needsAction 响应状态（accepted, declined, needsAction） └ next_page_token String CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI 请求结果若还有更多，则返回下一页的token值
success	Boolean	true	调用成功标识位
errmsg	String	service-unavaliable	错误信息
errcode	Number	15	错误码

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/calendar/list");
OapiCalendarListRequest req = new OapiCalendarListRequest();
req.setCalendarFolderId("1k3io5atbqjbgh9927j8d94abh");
DateTime obj1 = new DateTime();
obj1.setDateTime("2019-03-01T23:08:53+0800");
obj1.setTimeZone("Asia/Shanghai");
req.setTimeMin(obj1);
req.setUserId("123134568");
req.setSingleEvents(false);
req.setPageToken("CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI");
req.setMaxResults(300L);
DateTime obj2 = new DateTime();
obj2.setDateTime("2019-03-01T23:08:53+0800");
obj2.setTimeZone("Asia/Shanghai");
req.setTimeMax(obj2);
OapiCalendarListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/calendar/list");
OapiCalendarListRequest req = new OapiCalendarListRequest();
req.CalendarFolderId = "1k3io5atbqjbgh9927j8d94abh";
OapiCalendarListRequest.DateTimeDomain obj1 = new OapiCalendarListRequest.DateTimeDomain();
obj1.DateTime = "2019-03-01T23:08:53+0800";
obj1.TimeZone = "Asia/Shanghai";
req.TimeMin_ = obj1;
req.UserId = "123134568";
req.SingleEvents = false;
req.PageToken = "CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI";
req.MaxResults = 300L;
OapiCalendarListRequest.DateTimeDomain obj2 = new OapiCalendarListRequest.DateTimeDomain();
obj2.DateTime = "2019-03-01T23:08:53+0800";
obj2.TimeZone = "Asia/Shanghai";
req.TimeMax_ = obj2;
OapiCalendarListResponse 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 OapiCalendarListRequest;
$req->setCalendarFolderId("1k3io5atbqjbgh9927j8d94abh");
$time_min = new DateTime;
$time_min->date_time="2019-03-01T23:08:53+0800";
$time_min->time_zone="Asia/Shanghai";
$req->setTimeMin($time_min);
$req->setUserId("123134568");
$req->setSingleEvents("false");
$req->setPageToken("CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI");
$req->setMaxResults("300");
$time_max = new DateTime;
$time_max->date_time="2019-03-01T23:08:53+0800";
$time_max->time_zone="Asia/Shanghai";
$req->setTimeMax($time_max);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/calendar/list");

curl -X POST "https://oapi.dingtalk.com/topapi/calendar/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e74be7da-d187-44cc-bd41-fd39d275ed0e' \
-d 'calendar_folder_id=1k3io5atbqjbgh9927j8d94abh' \
-d 'max_results=300' \
-d 'page_token=CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI' \
-d 'single_events=false' \
-d 'time_max=null' \
-d 'time_min=null' \
-d 'user_id=123134568'

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

req=dingtalk.api.OapiCalendarListRequest("https://oapi.dingtalk.com/topapi/calendar/list")

req.calendar_folder_id="1k3io5atbqjbgh9927j8d94abh"
req.time_min=""
req.user_id="123134568"
req.single_events=false
req.page_token="CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI"
req.max_results=300
req.time_max=""
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.list");
add_param(pRequest,"calendar_folder_id","1k3io5atbqjbgh9927j8d94abh");
add_param(pRequest,"time_min","数据结构JSON示例");
add_param(pRequest,"user_id","123134568");
add_param(pRequest,"single_events","false");
add_param(pRequest,"page_token","CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI");
add_param(pRequest,"max_results","300");
add_param(pRequest,"time_max","数据结构JSON示例");
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.list', {
	'calendar_folder_id':'1k3io5atbqjbgh9927j8d94abh',
	'time_min':'数据结构JSON示例',
	'user_id':'123134568',
	'single_events':'false',
	'page_token':'CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI',
	'max_results':'300',
	'time_max':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "summary":"李四的日程",
        "items":[
            {
                    "unique_id":"k3io5atbqjbgh9927j8d94abh",
                    "recurrence_id":"1609466400000",
                    "organizer":{
                        "self":true,
                        "display_name":"张三",
                        "userid":"12323"
                    },
                    "recurrence":{
                        "string":[
                            "YEARLY;INTERVAL=2;BYMONTH=1;BYDAY=SU;BYHOUR=8",
                            "9（RFC5545 see link https:\/\/tools.ietf.org\/html\/rfc5545#section-3.8.5）"
                        ]
                    },
                    "end":{
                        "date":"2018-08-08",
                        "time_zone":"Asia\/Shanghai",
                        "date_time":"2019-03-01T23:08:53+0800"
                    },
                    "start":{
                        "date":"2018-08-08",
                        "time_zone":"Asia\/Shanghai",
                        "date_time":"2019-03-01T23:08:53+0800"
                    },
                    "location":"第三会议室",
                    "description":"今天下午在xx会见xx",
                    "summary":"日程标题（生日）",
                    "updated":{
                        "date":"2018-08-08",
                        "time_zone":"Asia\/Shanghai",
                        "date_time":"2019-03-01T23:08:53+0800"
                    },
                    "created":{
                        "date":"2018-08-08",
                        "time_zone":"Asia\/Shanghai",
                        "date_time":"2019-03-01T23:08:53+0800"
                    },
                    "status":"confirmed",
                    "id":"1k3io5atbqjbgh9927j8d94abh",
                    "response_status":"needsAction"
            }
        ],
        "next_page_token":"CjkKKzcza2E0OXRxMm91cmgwYXQ3a3JzcjRybzd2XzIwMTgwNzMwVDAzMzAwMFoYASCAgMCAsYi_phYaDQgAEgAY8IyPte3d4AI"
    },
    "success":true,
    "errmsg":"service-unavaliable",
    "errcode":15
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.calendar.list (日程查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈