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

dingtalk.corp.emp.search (企业通讯录员工搜索)

钉钉企业通讯录搜索接口, 支持翻页

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
keyword	String	可选	张三	搜索关键字
offset	Number	可选	0	偏移量
size	Number	可选	10	请求数量

响应参数

名称	类型	示例值	描述
result	Json	{"total":1,"hasMore":false,"list":[{"title":"职位","name":"钉钉","staffId":"1234"}]}	返回结果

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpEmpSearchRequest req = new CorpEmpSearchRequest();
req.setKeyword("张三");
req.setOffset(0L);
req.setSize(10L);
CorpEmpSearchResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpEmpSearchRequest req = new CorpEmpSearchRequest();
req.Keyword = "张三";
req.Offset = 0L;
req.Size = 10L;
CorpEmpSearchResponse 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 CorpEmpSearchRequest;
$req->setKeyword("张三");
$req->setOffset("0");
$req->setSize("10");
$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.emp.search' \
-d 'partner_id=apidoc' \
-d 'session=691a76d0-df13-48ba-91cd-14c7f28b1318' \
-d 'timestamp=2025-05-09+21%3A04%3A31' \
-d 'v=2.0' \
-d 'keyword=%E5%BC%A0%E4%B8%89' \
-d 'offset=0' \
-d 'size=10'

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

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

req.keyword="张三"
req.offset=0
req.size=10
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.emp.search");
add_param(pRequest,"keyword","张三");
add_param(pRequest,"offset","0");
add_param(pRequest,"size","10");
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.emp.search', {
	'keyword':'张三',
	'offset':'0',
	'size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_emp_search_response>
    <result>{&quot;total&quot;:1,&quot;hasMore&quot;:false,&quot;list&quot;:[{&quot;title&quot;:&quot;职位&quot;,&quot;name&quot;:&quot;钉钉&quot;,&quot;staffId&quot;:&quot;1234&quot;}]}</result>
</dingtalk_corp_emp_search_response>

{
    "dingtalk_corp_emp_search_response":{
        "result":"{\"total\":1,\"hasMore\":false,\"list\":[{\"title\":\"职位\",\"name\":\"钉钉\",\"staffId\":\"1234\"}]}"
    }
}

异常示例

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.emp.search (企业通讯录员工搜索)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ