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

dingtalk.oapi.extcontact.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
offset	Number	可选	0	默认值：0 最小值：0	支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。
size	Number	可选	20	默认值：20 最小值：1 最大值：100	支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小，最大100。

响应参数

名称	类型	示例值	描述
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 └ email String 1@1.com 邮箱
errcode	Number	0	errcode
errmsg	String	ok	errmsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.setOffset(0L);
req.setSize(20L);
OapiExtcontactListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.Offset = 0L;
req.Size = 20L;
OapiExtcontactListResponse 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 OapiExtcontactListRequest;
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/extcontact/list");

curl -X POST "https://oapi.dingtalk.com/topapi/extcontact/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=61c28863-191d-450c-98f9-d9f3e2d6138c' \
-d 'offset=0' \
-d 'size=20'

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

req=dingtalk.api.OapiExtcontactListRequest("https://oapi.dingtalk.com/topapi/extcontact/list")

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

响应示例

JSON示例

{
    "results":[
        {
                "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",
                "email":"1@1.com"
        }
    ],
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.extcontact.list (获取企业外部联系人列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ