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

dingtalk.smartwork.attends.getusergroup (获取用户考勤组)

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

公共参数

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

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

响应参数

名称	类型	示例值	描述
result	DingOpenResult	{}	result
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 {} 休息开始时间 └ check_time Date 14400000 开始时间 └ check_type String OnDuty 类型OnDuty：休息开始，OffDuty：休息结束 rest_end_time AtTimeVo {} 休息结束时间 └ check_time Date 18000000 结束时间 └ check_type String OffDuty 类型OnDuty：休息开始，OffDuty：休息结束 └ ding_open_errcode Number 0 dingOpenErrcode └ error_msg String ok errorMsg └ success Boolean true success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
SmartworkAttendsGetusergroupRequest req = new SmartworkAttendsGetusergroupRequest();
req.setUserid("zhangsan");
SmartworkAttendsGetusergroupResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
SmartworkAttendsGetusergroupRequest req = new SmartworkAttendsGetusergroupRequest();
req.Userid = "zhangsan";
SmartworkAttendsGetusergroupResponse 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_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new SmartworkAttendsGetusergroupRequest;
$req->setUserid("zhangsan");
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.smartwork.attends.getusergroup' \
-d 'partner_id=apidoc' \
-d 'session=97c8e557-445b-4ad2-a013-81daea06e5eb' \
-d 'timestamp=2025-05-09+21%3A32%3A44' \
-d 'v=2.0' \
-d 'userid=zhangsan'

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

req=dingtalk.api.SmartworkAttendsGetusergroupRequest("https://eco.taobao.com/router/rest")

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

响应示例

XML示例
JSON示例

<dingtalk_smartwork_attends_getusergroup_response>
    <result>
        <result>
            <name>考勤组1</name>
            <group_id>123</group_id>
            <type>TURN</type>
            <classes>
                <at_class_vo>
                    <class_id>456</class_id>
                    <name>A班</name>
                    <sections>
                        <at_section_vo>
                            <times>
                                <at_time_vo>
                                    <check_time>3600000</check_time>
                                    <check_type>OnDuty</check_type>
                                    <across>0</across>
                                    <begin_min>30</begin_min>
                                    <end_min>0</end_min>
                                </at_time_vo>
                            </times>
                        </at_section_vo>
                    </sections>
                    <setting>
                        <rest_begin_time>
                            <check_time>14400000</check_time>
                            <check_type>OnDuty</check_type>
                        </rest_begin_time>
                        <rest_end_time>
                            <check_time>18000000</check_time>
                            <check_type>OffDuty</check_type>
                        </rest_end_time>
                    </setting>
                </at_class_vo>
            </classes>
        </result>
        <ding_open_errcode>0</ding_open_errcode>
        <error_msg>ok</error_msg>
        <success>true</success>
    </result>
</dingtalk_smartwork_attends_getusergroup_response>

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

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.smartwork.attends.getusergroup (获取用户考勤组)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ