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

dingtalk.oapi.smartwork.hrm.employee.onjoblist.query (带查询参数查询在职员工)

智能人事业务，提供企业/ISV按在职状态分页查询公司在职员工id列表，提供额外的按参数过滤功能，比如按入职时间范围过滤

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
status_list	Number []	必须	[2,3,5,-1]	最大列表长度：999	在职员工子状态筛选。2，试用期；3，正式；5，待离职；-1，无状态
cursor	Number	必须	0		分页起始值，默认0开始
size	Number	必须	50		分页大小，最大50
search_param	EmpSearchParamVo	可选			查询参数
└ entry_start_date Date 可选 2017-12-12 12:12:12 开始入职日期 └ entry_end_date Date 可选 2017-12-12 12:12:12 结束入职日期

响应参数

名称	类型	示例值	描述
result	PageResult	{"data_list":["11","22"],"next_cursor":1,"has_more":true}	分页结果
└ has_more Boolean true 表示是否还有更多的数据 └ next_cursor Number 1 表示下一次分页的游标，如果next_corsor为null或者has_more为false，表示没有更多的分页数据 └ data_list String [] ["11","22"] 数据结果列表
success	Boolean	false	调用结果
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/onjoblist/query");
OapiSmartworkHrmEmployeeOnjoblistQueryRequest req = new OapiSmartworkHrmEmployeeOnjoblistQueryRequest();
req.setStatusList("2,3,5,-1");
req.setCursor(0L);
req.setSize(50L);
EmpSearchParamVo obj1 = new EmpSearchParamVo();
obj1.setEntryStartDate(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setEntryEndDate(StringUtils.parseDateTime("2017-12-12 12:12:12"));
req.setSearchParam(obj1);
OapiSmartworkHrmEmployeeOnjoblistQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/onjoblist/query");
OapiSmartworkHrmEmployeeOnjoblistQueryRequest req = new OapiSmartworkHrmEmployeeOnjoblistQueryRequest();
req.StatusList = "2,3,5,-1";
req.Cursor = 0L;
req.Size = 50L;
OapiSmartworkHrmEmployeeOnjoblistQueryRequest.EmpSearchParamVoDomain obj1 = new OapiSmartworkHrmEmployeeOnjoblistQueryRequest.EmpSearchParamVoDomain();
obj1.EntryStartDate = DateTime.Parse(2017-12-12 12:12:12");
obj1.EntryEndDate = DateTime.Parse(2017-12-12 12:12:12");
req.SearchParam_ = obj1;
OapiSmartworkHrmEmployeeOnjoblistQueryResponse 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 OapiSmartworkHrmEmployeeOnjoblistQueryRequest;
$req->setStatusList("[2,3,5,-1]");
$req->setCursor("0");
$req->setSize("50");
$search_param = new EmpSearchParamVo;
$search_param->entry_start_date="2017-12-12 12:12:12";
$search_param->entry_end_date="2017-12-12 12:12:12";
$req->setSearchParam($search_param);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/onjoblist/query");

curl -X POST "https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/onjoblist/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=baff81f1-7a70-4de8-8111-d79cfbc49e5f' \
-d 'cursor=0' \
-d 'search_param=null' \
-d 'size=50' \
-d 'status_list=2%2C3%2C5%2C-1'

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

req=dingtalk.api.OapiSmartworkHrmEmployeeOnjoblistQueryRequest("https://oapi.dingtalk.com/topapi/smartwork/hrm/employee/onjoblist/query")

req.status_list="[2,3,5,-1]"
req.cursor=0
req.size=50
req.search_param=""
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.onjoblist.query");
add_param(pRequest,"status_list","2,3,5,-1");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","50");
add_param(pRequest,"search_param","数据结构JSON示例");
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.onjoblist.query', {
	'status_list':'2,3,5,-1',
	'cursor':'0',
	'size':'50',
	'search_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "has_more":true,
        "next_cursor":1,
        "data_list":{
            "string":[
                "[\"11\"",
                "\"22\"]"
            ]
        }
    },
    "success":false,
    "errcode":400020,
    "errmsg":"无访问权限"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.smartwork.hrm.employee.onjoblist.query (带查询参数查询在职员工)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈