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

dingtalk.corp.search.corpcontact.baseinfo (搜索企业通讯录基本接口)

根据姓名和工号搜索企业员工

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
query	String	必须	测试	搜索词,长度大于2开始搜
offset	Number	必须	0	开始位置,从0开始
size	Number	必须	10	拉取个数上限100

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
page_result PageResult pageResult └ has_more Boolean true 是否还有更多数据 └ offset Number 3 下次翻页的入参 └ total Number 5000 能获取的总条数(offset+size不能超过这个值) value_list GroupContactResult [] value └ name String 张三姓名 └ title String 开发职位 └ ali_tmp_dept String 阿里-钉钉-开发 aliTmpDept └ flower_name String 李四 flowerName └ job_number String 1234 jobNumber └ userid String dsiecs userid └ work_station String 办公室 workStation └ ding_open_errcode Number dingOpenErrcode └ error_msg String errorMsg └ success Boolean success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpSearchCorpcontactBaseinfoRequest req = new CorpSearchCorpcontactBaseinfoRequest();
req.setQuery("测试");
req.setOffset(0L);
req.setSize(10L);
CorpSearchCorpcontactBaseinfoResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpSearchCorpcontactBaseinfoRequest req = new CorpSearchCorpcontactBaseinfoRequest();
req.Query = "测试";
req.Offset = 0L;
req.Size = 10L;
CorpSearchCorpcontactBaseinfoResponse 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 CorpSearchCorpcontactBaseinfoRequest;
$req->setQuery("测试");
$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.search.corpcontact.baseinfo' \
-d 'partner_id=apidoc' \
-d 'session=fbef9cfc-4203-438c-ae70-51dcffee89fe' \
-d 'timestamp=2025-06-10+08%3A12%3A19' \
-d 'v=2.0' \
-d 'offset=0' \
-d 'query=%E6%B5%8B%E8%AF%95' \
-d 'size=10'

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

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

req.query="测试"
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.search.corpcontact.baseinfo");
add_param(pRequest,"query","测试");
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.search.corpcontact.baseinfo', {
	'query':'测试',
	'offset':'0',
	'size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_search_corpcontact_baseinfo_response>
    <result>
        <page_result>
            <has_more>true</has_more>
            <offset>3</offset>
            <total>5000</total>
            <value_list>
                <group_contact_result>
                    <name>张三</name>
                    <title>开发</title>
                    <ali_tmp_dept>阿里-钉钉-开发</ali_tmp_dept>
                    <flower_name>李四</flower_name>
                    <job_number>1234</job_number>
                    <userid>dsiecs</userid>
                    <work_station>办公室</work_station>
                </group_contact_result>
            </value_list>
        </page_result>
        <ding_open_errcode></ding_open_errcode>
        <error_msg></error_msg>
        <success></success>
    </result>
</dingtalk_corp_search_corpcontact_baseinfo_response>

{
    "dingtalk_corp_search_corpcontact_baseinfo_response":{
        "result":{
            "page_result":{
                "has_more":true,
                "offset":3,
                "total":5000,
                "value_list":{
                    "group_contact_result":[
                        {
                            "name":"张三",
                            "title":"开发",
                            "ali_tmp_dept":"阿里-钉钉-开发",
                            "flower_name":"李四",
                            "job_number":"1234",
                            "userid":"dsiecs",
                            "work_station":"办公室"
                        }
                    ]
                }
            },
            "ding_open_errcode":,
            "error_msg":"",
            "success":
        }
    }
}

异常示例

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.search.corpcontact.baseinfo (搜索企业通讯录基本接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈