钉钉开发文档

签到

更新时间: 2019-4-8

获取部门用户签到记录

企业使用此接口可获取部门人员的签到记录,进行统计分析,也可以基于高德地图(http://lbs.amap.com/)API接口开发人员分布图和热力图。
注意:目前最多获取1000人以内的签到数据,如果所传部门ID及其子部门下的user超过1000,会报错。

请求方式:GET(HTTPS)
请求地址https://oapi.dingtalk.com/checkin/record?access_token=ACCESS_TOKEN&department_id=1&start_time=1467707227000&end_time=1467707240000&offset=0&size=100&order=asc
参数说明

参数 参数说明 必须 说明
access_token String 调用接口凭证
department_id String 部门id(1 表示根部门)
start_time long 开始时间。Unix时间戳,如:1520956800000
end_time long 结束时间。Unix时间戳,如:1520956800000。开始时间和结束时间的间隔不能大于45天
offset long 支持分页查询,与size 参数同时设置时才生效,此参数代表偏移量,从0、1、2...依次递增
size int 支持分页查询,与offset 参数同时设置时才生效,此参数代表分页大小,最大100
order String 排序
asc 为正序
desc 为倒序

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/checkin/record");
OapiCheckinRecordRequest request = new OapiCheckinRecordRequest();
request.setDepartmentId("1");
request.setStartTime(System.currentTimeMillis()-TimeUnit.DAYS.toMillis(1));
request.setEndTime(System.currentTimeMillis());
request.setOffset(0L);
request.setOrder("asc");
request.setSize(100L);
request.setHttpMethod("GET");
OapiCheckinRecordResponse response = client.execute(request, accessToken);

返回结果

{
"errcode": 0,
"errmsg": "ok",
"data": [
         {
          "name": "xxx",
          "userId": "xxx",
          "timestamp": 1467300937000,
          "avatar": "http://i01.lw.aliimg.com/media/lADOAGgal80Cyc0CyQ_713_713.jpg",
          "place": "xxx",
          "detailPlace": "xxx",
          "remark": "",
	  "latitude": 30.280314,
          "longitude": 120.060573,
          "imageList": []
         },
         {
          "name": "xxx",
          "userId": "xxx",
          "timestamp": 1467300927000,
          "avatar": "http://i01.lw.aliimg.com/media/lADOAGgal80Cyc0CyQ_713_713.jpg",
          "place": "xxxx",
          "detailPlace": "xxxx",
          "remark": "",
	  "latitude": 30.280314,
          "longitude": 120.060573,
          "imageList": [
                         "http://static.dingtalk.com/media/lADOU75g9M0ECs0C0A_720_1034.jpg"
                       ]
        }
       ]
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
name 成员名称
userId 员工唯一标识ID(不可修改)
avatar 头像url
timestamp 签到时间。Unix时间戳
place 签到地址
detailPlace 签到详细地址
remark 签到备注
imageList 签到照片url列表
latitude 纬度
longitude 经度

获取用户签到记录

企业使用此接口可获取指定人员的签到记录,进行统计分析,也可以基于高德地图(http://lbs.amap.com)API接口开发人员分布图和热力图。

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/checkin/record/get?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
userid_list String 必须 zhangsan, lisi 需要查询的用户列表,最大列表长度:10
start_time Number 必须 1494126861000 起始时间。Unix时间戳,如:1520956800000
end_time Number 必须 1495126861000 结束时间。Unix时间戳,如:1520956800000。如果是取1个人的数据,时间范围最大到10天,如果是取多个人的数据,时间范围最大1天。
cursor Number 必须 0 分页查询的游标,最开始可以传0,然后以1、2依次递增
size Number 必须 100 分页查询的每页大小,最大100

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/checkin/record/get");
OapiCheckinRecordGetRequest request = new OapiCheckinRecordGetRequest();
request.setStartTime(System.currentTimeMillis()-TimeUnit.DAYS.toMillis(1));
request.setEndTime(System.currentTimeMillis());
request.setSize(100L);
request.setCursor(0L);
request.setUseridList("1226682231742708,zhansan");
OapiCheckinRecordGetResponse response = client.execute(request, accessToken);

返回结果

{
    "result":{
        "next_cursor":100,
        "page_list":[
            {
                    "checkin_time":1494852872446,
                    "image_list":"http://image,http://image",
                    "detail_place":"家里详细地址",
                    "remark":"备注",
                    "userid":"080517",
                    "place":"家里",
                    "longitude":"30.28030734592014",
                    "latitude":"31.28030734592014",
                    "visit_user":"080517"
            }
        ]
    },
    "errcode":0,
    "errmsg":"OK"
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
result
└ next_cursor 表示下次查询的游标,为null代表没有更多的数据
└ page_list 分页列表
└ checkin_time 签到时间,单位毫秒
└ image_list 签到照片url列表
└ detail_place 签到详细地址
└ remark 签到备注
└ userid 员工唯一标识
└ place 签到地址
└ longitude 签到位置经度(暂未开放)
└ latitude 签到位置纬度(暂未开放)
└ visit_user 签到的拜访对象,可以为外部联系人的userid或者用户自己输入的名字
以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!