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

dingtalk.oapi.attendance.list (考勤打卡数据开放)

该接口仅限企业接入使用，用于返回企业内员工的实际打卡结果。比如，企业给一个员工设定的排班是上午9点和下午6点各打一次卡，即使员工在这期间打了多次，该接口也只会返回两条记录，包括上午的打卡结果和下午的打卡结果

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
workDateFrom	String	可选	yyyy-MM-dd hh:mm:ss	查询考勤打卡记录的起始工作日
workDateTo	String	可选	yyyy-MM-dd hh:mm:ss	查询考勤打卡记录的结束工作日
userIdList	String	可选	1	员工在企业内的UserID列表，企业用来唯一标识用户的字段
offset	Number	可选	0	表示获取考勤数据的起始点，第一次传0，如果还有多余数据，下次获取传的offset值为之前的offset+limit
limit	Number	可选	100	表示获取考勤数据的条数，最大不能超过50条
isI18n	Boolean	可选	true	是否国际化

响应参数

名称	类型	示例值	描述
recordresult	Recordresult []		recordresult
└ sourceType String sourceType └ baseCheckTime Date baseCheckTime └ userCheckTime Date userCheckTime └ procInstId String procInstId └ approveId Number approveId └ locationResult String locationResult └ timeResult String timeResult └ checkType String checkType └ userId String userId └ workDate Date workDate └ recordId Number recordId └ planId Number planId └ groupId Number groupId └ id Number id
hasMore	Boolean		hasMore
errmsg	String	ok	errmsg
errcode	Number	0	errcode

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/attendance/list");
OapiAttendanceListRequest req = new OapiAttendanceListRequest();
req.setWorkDateFrom("yyyy-MM-dd hh:mm:ss");
req.setWorkDateTo("yyyy-MM-dd hh:mm:ss");
req.setUserIdList("1");
req.setOffset(0L);
req.setLimit(100L);
req.setIsI18n(true);
OapiAttendanceListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/attendance/list");
OapiAttendanceListRequest req = new OapiAttendanceListRequest();
req.WorkDateFrom = "yyyy-MM-dd hh:mm:ss";
req.WorkDateTo = "yyyy-MM-dd hh:mm:ss";
req.UserIdList = "1";
req.Offset = 0L;
req.Limit = 100L;
req.IsI18n = true;
OapiAttendanceListResponse 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 OapiAttendanceListRequest;
$req->setWorkDateFrom("yyyy-MM-dd hh:mm:ss");
$req->setWorkDateTo("yyyy-MM-dd hh:mm:ss");
$req->setUserIdList("1");
$req->setOffset("0");
$req->setLimit("100");
$req->setIsI18n("true");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/attendance/list");

curl -X POST "https://oapi.dingtalk.com/attendance/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f6593a73-59a9-4242-8497-bcc5ae1d96c1' \
-d 'isI18n=true' \
-d 'limit=100' \
-d 'offset=0' \
-d 'userIdList=1' \
-d 'workDateFrom=yyyy-MM-dd+hh%3Amm%3Ass' \
-d 'workDateTo=yyyy-MM-dd+hh%3Amm%3Ass'

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

req=dingtalk.api.OapiAttendanceListRequest("https://oapi.dingtalk.com/attendance/list")

req.workDateFrom="yyyy-MM-dd hh:mm:ss"
req.workDateTo="yyyy-MM-dd hh:mm:ss"
req.userIdList="1"
req.offset=0
req.limit=100
req.isI18n=true
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.attendance.list");
add_param(pRequest,"workDateFrom","yyyy-MM-dd hh:mm:ss");
add_param(pRequest,"workDateTo","yyyy-MM-dd hh:mm:ss");
add_param(pRequest,"userIdList","1");
add_param(pRequest,"offset","0");
add_param(pRequest,"limit","100");
add_param(pRequest,"isI18n","true");
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.attendance.list', {
	'workDateFrom':'yyyy-MM-dd hh:mm:ss',
	'workDateTo':'yyyy-MM-dd hh:mm:ss',
	'userIdList':'1',
	'offset':'0',
	'limit':'100',
	'isI18n':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "recordresult":[
        {
                "sourceType":"",
                "baseCheckTime":"",
                "userCheckTime":"",
                "procInstId":"",
                "approveId":,
                "locationResult":"",
                "timeResult":"",
                "checkType":"",
                "userId":"",
                "workDate":"",
                "recordId":,
                "planId":,
                "groupId":,
                "id":
        }
    ],
    "hasMore":,
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.attendance.list (考勤打卡数据开放)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ