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

dingtalk.oapi.attendance.getusergroup (获取用户考勤组)

在钉钉考勤微应用中，考勤组是一类具有相同的班次、考勤位置等考勤规则的人或部门的组合，一个企业中的一个人只能属于一个考勤组。如果您的企业使用了钉钉考勤并希望获取员工的考勤组信息，可选择使用此接口

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
userid	String	必须	zhangsan		员工在企业内的UserID，企业用来唯一标识用户的字段。

响应参数

名称	类型	示例值	描述
result	AtGroupFullForTopVo	{}	result
└ name String 考勤组1 考勤组名称 └ group_id Number 123 考勤组id └ type String TURN 考勤组类型 classes AtClassVo [] [] 考勤组中的班次列表 └ class_id Number 456 班次id └ name String A班班次名称 sections AtSectionVo [] [] 班次中上下班列表 times AtTimeVo [] [] 班次中上下班详情列表 └ check_time Date 3600000 打卡时间 └ check_type String OnDuty 打卡类型OnDuty：上班，OffDuty：下班 └ across Number 0 打卡时间跨几天 └ begin_min Number 30 允许的最早提前打卡时间，分钟为单位 └ end_min Number 0 允许的最晚延后打卡时间，分钟为单位 setting ClassSettingVo {} 班次配置 rest_begin_time AtTimeVo {} 休息开始时间 └ across Number 0 across └ begin_min Number 0 beginMin └ end_min Number 0 endMin └ check_time Date 14400000 开始时间 └ check_type String OnDuty 类型OnDuty：休息开始，OffDuty：休息结束 rest_end_time AtTimeVo {} 休息结束时间 └ across Number 0 across └ begin_min Number 0 beginMin └ end_min Number 0 endMin └ check_time Date 18000000 结束时间 └ check_type String OffDuty 类型OnDuty：休息开始，OffDuty：休息结束
errcode	Number	0	errcode
errmsg	String	ok	errmsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/attendance/getusergroup");
OapiAttendanceGetusergroupRequest req = new OapiAttendanceGetusergroupRequest();
req.setUserid("zhangsan");
OapiAttendanceGetusergroupResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/attendance/getusergroup");
OapiAttendanceGetusergroupRequest req = new OapiAttendanceGetusergroupRequest();
req.Userid = "zhangsan";
OapiAttendanceGetusergroupResponse 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 OapiAttendanceGetusergroupRequest;
$req->setUserid("zhangsan");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/attendance/getusergroup");

curl -X POST "https://oapi.dingtalk.com/topapi/attendance/getusergroup" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e8311b30-b552-45c9-a080-b4842851591f' \
-d 'userid=zhangsan'

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

req=dingtalk.api.OapiAttendanceGetusergroupRequest("https://oapi.dingtalk.com/topapi/attendance/getusergroup")

req.userid="zhangsan"
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.getusergroup");
add_param(pRequest,"userid","zhangsan");
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.getusergroup', {
	'userid':'zhangsan'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "name":"考勤组1",
        "group_id":123,
        "type":"TURN",
        "classes":[
            {
                    "class_id":456,
                    "name":"A班",
                    "sections":[
                        {
                                "times":[
                                    {
                                            "check_time":"3600000",
                                            "check_type":"OnDuty",
                                            "across":0,
                                            "begin_min":30,
                                            "end_min":0
                                    }
                                ]
                        }
                    ],
                    "setting":{
                        "rest_begin_time":{
                            "across":0,
                            "begin_min":0,
                            "end_min":0,
                            "check_time":"14400000",
                            "check_type":"OnDuty"
                        },
                        "rest_end_time":{
                            "across":0,
                            "begin_min":0,
                            "end_min":0,
                            "check_time":"18000000",
                            "check_type":"OffDuty"
                        }
                    }
            }
        ]
    },
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.attendance.getusergroup (获取用户考勤组)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ