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

dingtalk.corp.hrm.employee.get (获取智能人事员工花名册详细数据)

获取智能人事指定员工花名册详细数据

公共参数

请求地址：

环境	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	必须	11111		查询用户userid

响应参数

名称	类型	示例值	描述
result	DingOpenResult	{...}	返回结果
group_list FieldGroupVpo [] [{...},{...}] 花名册分组列表 field_list SysCustomFieldVpo [] [{...},{...}] 字段列表 └ hidden_from_employee_flag Boolean true 对员工不可见 └ contact_client_flag Boolean true 是否通讯录client字段 └ contact_system_flag Boolean true 是否通讯录系统字段 └ contact_flag Boolean true 是否通讯录字段 └ system_flag Boolean true 是否系统字段 └ value String 字段的值字段的值 └ hint String 请选择提醒 └ option_text String ["女","男"] 选项值 └ type_name String - 类型名 └ field_type String - 字段类型 └ required Boolean true required └ editable_by_hr Boolean true editableByHr └ deleted Boolean true 是否已删除 └ editable_by_emp Boolean true editableByEmp └ visible_by_emp Boolean true visibleByEmp └ group_id String sys02 groupId └ field_name String 手机号码字段名称 └ field_code String d1f3 字段code └ corp_id String ding123123 corpId └ emp_profile_required Boolean true 在个人信息展示 └ key String certType 字段key └ contact_source Number 1 通讯录来源 └ no_watermark Boolean true 是否需要水印 └ confirm_entry_required Boolean true 确认入职是否必填 └ group_name String 工作信息花名册分组名 └ group_id String sys02 花名册分组id └ ding_open_errcode Number 略 dingOpenErrcode └ error_msg String 参数异常错误信息 └ success Boolean true 是否成功

请求示例

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

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

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpHrmEmployeeGetRequest req = new CorpHrmEmployeeGetRequest();
req.Userid = "11111";
CorpHrmEmployeeGetResponse 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 CorpHrmEmployeeGetRequest;
$req->setUserid("11111");
$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.corp.hrm.employee.get' \
-d 'partner_id=apidoc' \
-d 'session=0a396a1d-2255-4542-8c45-ac03cef5121c' \
-d 'timestamp=2025-05-09+22%3A03%3A23' \
-d 'v=2.0' \
-d 'userid=11111'

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

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

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

响应示例

XML示例
JSON示例

<dingtalk_corp_hrm_employee_get_response>
    <result>
        <group_list>
            <field_group_vpo>
                <field_list>
                    <sys_custom_field_vpo>
                        <hidden_from_employee_flag>true</hidden_from_employee_flag>
                        <contact_client_flag>true</contact_client_flag>
                        <contact_system_flag>true</contact_system_flag>
                        <contact_flag>true</contact_flag>
                        <system_flag>true</system_flag>
                        <value>字段的值</value>
                        <hint>请选择</hint>
                        <option_text>[&quot;女&quot;,&quot;男&quot;]</option_text>
                        <type_name>-</type_name>
                        <field_type>-</field_type>
                        <required>true</required>
                        <editable_by_hr>true</editable_by_hr>
                        <deleted>true</deleted>
                        <editable_by_emp>true</editable_by_emp>
                        <visible_by_emp>true</visible_by_emp>
                        <group_id>sys02</group_id>
                        <field_name>手机号码</field_name>
                        <field_code>d1f3</field_code>
                        <corp_id>ding123123</corp_id>
                        <emp_profile_required>true</emp_profile_required>
                        <key>certType</key>
                        <contact_source>1</contact_source>
                        <no_watermark>true</no_watermark>
                        <confirm_entry_required>true</confirm_entry_required>
                    </sys_custom_field_vpo>
                </field_list>
                <group_name>工作信息</group_name>
                <group_id>sys02</group_id>
            </field_group_vpo>
        </group_list>
        <ding_open_errcode>略</ding_open_errcode>
        <error_msg>参数异常</error_msg>
        <success>true</success>
    </result>
</dingtalk_corp_hrm_employee_get_response>

{
    "dingtalk_corp_hrm_employee_get_response":{
        "result":{
            "group_list":{
                "field_group_vpo":[
                    {
                        "field_list":{
                            "sys_custom_field_vpo":[
                                {
                                    "hidden_from_employee_flag":true,
                                    "contact_client_flag":true,
                                    "contact_system_flag":true,
                                    "contact_flag":true,
                                    "system_flag":true,
                                    "value":"字段的值",
                                    "hint":"请选择",
                                    "option_text":"[\"女\",\"男\"]",
                                    "type_name":"-",
                                    "field_type":"-",
                                    "required":true,
                                    "editable_by_hr":true,
                                    "deleted":true,
                                    "editable_by_emp":true,
                                    "visible_by_emp":true,
                                    "group_id":"sys02",
                                    "field_name":"手机号码",
                                    "field_code":"d1f3",
                                    "corp_id":"ding123123",
                                    "emp_profile_required":true,
                                    "key":"certType",
                                    "contact_source":1,
                                    "no_watermark":true,
                                    "confirm_entry_required":true
                                }
                            ]
                        },
                        "group_name":"工作信息",
                        "group_id":"sys02"
                    }
                ]
            },
            "ding_open_errcode":略,
            "error_msg":"参数异常",
            "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.corp.hrm.employee.get (获取智能人事员工花名册详细数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ