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

dingtalk.corp.extcontact.list (外部联系人列表)

获取企业外部联系人列表

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
size	Number	可选	20	默认值：20 最大值：100	分页大小, 最大100
offset	Number	可选	0	默认值：0	偏移位置

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
results OpenExtContact [] result └ title String 开发工程师职位 └ share_dept_ids Number [] 1,2,3 共享部门ID列表 └ label_ids Number [] 1,2,3 标签 └ remark String 备注内容备注 └ address String 地址内容地址 └ name String 张三姓名 └ follower_user_id String 6767531692 负责人UserID └ state_code String 86 国家码 └ company_name String 钉钉公司名 └ share_user_ids String [] 042059613752 共享员工UserID列表 └ mobile String 13088888888 手机号 └ userid String 0123456789 外部联系人UserID └ ding_open_errcode Number 0 dingOpenErrcode └ error_msg String 成功 errorMsg └ success Boolean true success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpExtcontactListRequest req = new CorpExtcontactListRequest();
req.setSize(20L);
req.setOffset(0L);
CorpExtcontactListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpExtcontactListRequest req = new CorpExtcontactListRequest();
req.Size = 20L;
req.Offset = 0L;
CorpExtcontactListResponse 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 CorpExtcontactListRequest;
$req->setSize("20");
$req->setOffset("0");
$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.extcontact.list' \
-d 'partner_id=apidoc' \
-d 'session=123eb950-2aba-4dd8-bfe1-1caf96d92955' \
-d 'timestamp=2025-04-24+15%3A16%3A49' \
-d 'v=2.0' \
-d 'offset=0' \
-d 'size=20'

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

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

req.size=20
req.offset=0
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.extcontact.list");
add_param(pRequest,"size","20");
add_param(pRequest,"offset","0");
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.extcontact.list', {
	'size':'20',
	'offset':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_extcontact_list_response>
    <result>
        <results>
            <open_ext_contact>
                <title>开发工程师</title>
                <share_dept_ids>
                    <number>1</number>
                    <number>2</number>
                    <number>3</number>
                </share_dept_ids>
                <label_ids>
                    <number>1</number>
                    <number>2</number>
                    <number>3</number>
                </label_ids>
                <remark>备注内容</remark>
                <address>地址内容</address>
                <name>张三</name>
                <follower_user_id>6767531692</follower_user_id>
                <state_code>86</state_code>
                <company_name>钉钉</company_name>
                <share_user_ids>
                    <string>042059613752</string>
                </share_user_ids>
                <mobile>13088888888</mobile>
                <userid>0123456789</userid>
            </open_ext_contact>
        </results>
        <ding_open_errcode>0</ding_open_errcode>
        <error_msg>成功</error_msg>
        <success>true</success>
    </result>
</dingtalk_corp_extcontact_list_response>

{
    "dingtalk_corp_extcontact_list_response":{
        "result":{
            "results":{
                "open_ext_contact":[
                    {
                        "title":"开发工程师",
                        "share_dept_ids":{
                            "number":[
                                1,
                                2,
                                3
                            ]
                        },
                        "label_ids":{
                            "number":[
                                1,
                                2,
                                3
                            ]
                        },
                        "remark":"备注内容",
                        "address":"地址内容",
                        "name":"张三",
                        "follower_user_id":"6767531692",
                        "state_code":"86",
                        "company_name":"钉钉",
                        "share_user_ids":{
                            "string":[
                                "042059613752"
                            ]
                        },
                        "mobile":"13088888888",
                        "userid":"0123456789"
                    }
                ]
            },
            "ding_open_errcode":0,
            "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.extcontact.list (外部联系人列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈