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

dingtalk.oapi.smartwork.hrm.employee.v2.list (智能人事获取员工花名册信息)

获取员工花名册指定字段的信息，支持明细分组字段

公共参数

环境	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_list	String []	必须	["1", "2", "3"]	最大列表长度：100	员工id列表
field_filter_list	String []	可选	["sys01-employeeStatus", "sys01-regularTime"]	最大列表长度：100	需要获取的花名册字段信息(不传值时，企业调用获取全部字段，ISV调用获取所有有权限字段。查询字段越少，RT越低，建议按需查询)
agentid	Number	必须	1		微应用在企业的agentId

响应参数

名称	类型	示例值	描述
result	EmpRosterFieldVo []	[ { "corpId": "ding20a11b7f29e803e535c2f4657eb6378f", "fieldDataList": [ { "fieldName": "出生日期", "fieldCode": "sys02-birthTime", "groupId": "sys02", "fieldValueList": [ { "itemIndex": 0, "label": "1990-01-01", "value": "1990-01-01" } ] }, { "fieldName": "毕业院校", "fieldCode": "sys03-graduateSchool", "groupId": "sys03", "fieldValueList": [ { "itemIndex": 0, "label": "1", "value": "1" }, { "itemIndex": 1, "label": "2", "value": "2" } ] }, { "fieldName": "学历", "fieldCode": "sys03-highestEdu", "groupId": "sys03", "fieldValueList": [ { "itemIndex": 0, "label": "小学", "value": "9" }, { "itemIndex": 1, "label": "初中", "value": "8" } ] } ], "staffId": "0425193814670062" } ]	返回结果
└ corp_id String ding20a11b7f29e803e535c2f4657eb6378f 企业id field_data_list EmpFieldDataVo [] [ { "fieldName": "出生日期", "fieldCode": "sys02-birthTime", "groupId": "sys02", "fieldValueList": [ { "itemIndex": 0, "label": "1990-01-01", "value": "1990-01-01" } ] }, { "fieldName": "毕业院校", "fieldCode": "sys03-graduateSchool", "groupId": "sys03", "fieldValueList": [ { "itemIndex": 0, "label": "1", "value": "1" }, { "itemIndex": 1, "label": "2", "value": "2" } ] }, { "fieldName": "学历", "fieldCode": "sys03-highestEdu", "groupId": "sys03", "fieldValueList": [ { "itemIndex": 0, "label": "小学", "value": "9" }, { "itemIndex": 1, "label": "初中", "value": "8" } ] } ] 字段信息列表 └ field_name String 员工状态字段名称 └ field_code String sys01-employeeStatus 字段标识 └ group_id String sys01 分组标识 field_value_list FieldValueVo [] [ { "itemIndex": 0, "label": "小学", "value": "9" }, { "itemIndex": 1, "label": "初中", "value": "8" } ] 字段值列表（明细分组字段包含多条、非明细分组仅一条记录） └ item_index Number 0 标识第几条明细（下标从0开始） └ label String 正式字段展示值（选项类型字段对应选项的value） └ value String 3 字段取值（选项类型字段对应选项的key） └ userid String 0425193814670062 员工id └ unionid String 3814670062 根据企业ID和钉钉用户ID生成的唯一ID
success	Boolean	true	调用是否成功
errcode	Number	400020	错误码
errmsg	String	无访问权限	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/v2/list");
OapiSmartworkHrmEmployeeV2ListRequest req = new OapiSmartworkHrmEmployeeV2ListRequest();
req.setUseridList(""1", "2", "3"");
req.setFieldFilterList(""sys01-employeeStatus", "sys01-regularTime"");
req.setAgentid(1L);
OapiSmartworkHrmEmployeeV2ListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/v2/list");
OapiSmartworkHrmEmployeeV2ListRequest req = new OapiSmartworkHrmEmployeeV2ListRequest();
req.UseridList = ""1", "2", "3"";
req.FieldFilterList = ""sys01-employeeStatus", "sys01-regularTime"";
req.Agentid = 1L;
OapiSmartworkHrmEmployeeV2ListResponse 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 OapiSmartworkHrmEmployeeV2ListRequest;
$req->setUseridList("[\"1\", \"2\", \"3\"]");
$req->setFieldFilterList("[\"sys01-employeeStatus\", \"sys01-regularTime\"]");
$req->setAgentid("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/v2/list");

curl -X POST "https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/v2/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ac425679-a9c5-4787-958d-85ad24ea8e7c' \
-d 'agentid=1' \
-d 'field_filter_list=%22sys01-employeeStatus%22%2C+%22sys01-regularTime%22' \
-d 'userid_list=%221%22%2C+%222%22%2C+%223%22'

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

req=dingtalk.api.OapiSmartworkHrmEmployeeV2ListRequest("https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/v2/list")

req.userid_list="["1", "2", "3"]"
req.field_filter_list="["sys01-employeeStatus", "sys01-regularTime"]"
req.agentid=1
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.smartwork.hrm.employee.v2.list");
add_param(pRequest,"userid_list",""1", "2", "3"");
add_param(pRequest,"field_filter_list",""sys01-employeeStatus", "sys01-regularTime"");
add_param(pRequest,"agentid","1");
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.smartwork.hrm.employee.v2.list', {
	'userid_list':'"1", "2", "3"',
	'field_filter_list':'"sys01-employeeStatus", "sys01-regularTime"',
	'agentid':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":[
        {
                "corp_id":"ding20a11b7f29e803e535c2f4657eb6378f",
                "field_data_list":[
                    {
                            "field_name":"员工状态",
                            "field_code":"sys01-employeeStatus",
                            "group_id":"sys01",
                            "field_value_list":[
                                {
                                        "item_index":0,
                                        "label":"正式",
                                        "value":"3"
                                }
                            ]
                    }
                ],
                "userid":"0425193814670062",
                "unionid":"3814670062"
        }
    ],
    "success":true,
    "errcode":400020,
    "errmsg":"无访问权限"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartwork.hrm.employee.v2.list (智能人事获取员工花名册信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ