跳转到主要内容
调用本接口，获取企业外部联系人列表。

​
请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/extcontact/list
HTTP MethodPOST
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_ext_read-企业外部联系人读权限

​
查询参数

名称类型是否必填示例值描述
access_tokenString是6d1bxxxx调用该API的应用凭证。 - 企业内部应用，通过获取企业内部应用的access_token接口获取。 - 第三方企业应用，通过获取第三方企业的access_token接口获取。

​
请求体

名称类型是否必填示例值描述
sizeNumber否20支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小，最大100。
offsetNumber否0支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。

​
请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/extcontact/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=b5039xxxx8bcc' \
-d 'offset=0' \
-d 'size=20'
Java 
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.setSize(20L);
req.setOffset(0L);
OapiExtcontactListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python 
import dingtalk.api

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

req.offset=0
req.size=20
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP 
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.io/topapi/extcontact/list");
C# 
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.Offset = 0L;
req.Size = 20L;
OapiExtcontactListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

​
响应

​
响应体

名称类型示例值描述
resultsOpenExtContact[]查询结果。
titleString开发工程师职位。
share_dept_idsNumber[]1,2,3共享部门ID列表。
label_idsNumber[]1,2,3外部联系人标签列表。
remarkString备注内容备注。
addressString地址内容地址。
nameString张三姓名。
follower_user_idString6767531692负责人的userid。
state_codeString86国家码。
company_nameString钉钉公司名。
share_user_idsString[]042059613752共享员工userid列表。
mobileString13088888888手机号。 说明 第三方企业应用不返回此参数。
useridString0123456789外部联系人的userid。
emailString1@1.com邮箱。
errcodeNumber0返回码。
errmsgStringok返回码描述。
request_idString439eqp31da45请求ID。

​
响应体示例

{
  "errcode": 0,
  "results": [
    {
      "address": "北京",
      "company_name": "钉钉",
      "email": "zhang@example.com",
      "follower_user_id": "manager4220",
      "label_ids": [
        1517
      ],
      "mobile": "1360054xxxx",
      "name": "王经理",
      "remark": "技术负责人",
      "share_dept_ids": [
        42536
      ],
      "share_user_ids": [
        "0423752"
      ],
      "state_code": "86",
      "title": "CFO",
      "userid": "01129774889"
    }
  ],
  "request_id": "439eqp31da45"
}

​
错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。
错误码（errcode）错误码描述（errmsg）解决方案
33009无效的tokenGrantType请检查access_token是否正确
40069无效的size请调整分页大小
40068无效的偏移量请调整偏移量
400001系统错误请稍后再试