跳转到主要内容
调用本接口,获取企业外部联系人的详细信息。

请求

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

查询参数

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

请求体

名称类型是否必填示例值描述
user_idString112500xxxx4889外部联系人userId,可调用获取外部联系人列表接口获取userid参数值。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/extcontact/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=53584xxxx2c50b' \
-d 'user_id=112500xxxx4889'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.setUserId("112500xxxx4889");
OapiExtcontactGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiExtcontactGetRequest("https://oapi.dingtalk.io/topapi/extcontact/get")

req.user_id="112500xxxx4889"
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 OapiExtcontactGetRequest;
$req->setUserId("112500xxxx4889");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/extcontact/get");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.UserId = "112500xxxx4889";
OapiExtcontactGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
resultOpenExtContact查询结果。
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。
emailStringxxx@1.com邮箱。
errcodeNumber0返回码。
errmsgStringok返回码描述。
request_idStringxrudojam4g8f请求ID。

响应体示例

{
  "errcode":0,
  "result":{
    "share_user_ids":[
      "66220007745510"
    ],
    "follower_user_id":"manager4220",
    "address":"北京",
    "share_dept_ids":[],
    "label_ids":[
      1561077317
    ],
    "share_dept_ids": [
      42xxxx36
    ],
    "mobile":"136***47616",
    "remark":"技术负责人",
    "title":"CFO",
    "userid":"011250026469774889",
    "company_name":"钉钉",
    "name":"王经理",
    "state_code":"86",
    "email":"zhang@example.com"
  },
  "request_id":"xrudojam4g8f"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errcode)错误码描述(errmsg)解决方案
33009无效的tokenGrantType请检查access_token是否正确
33012无效的userId请检查userId是否正确
43007需要操作权限请检查access_token是否具有操作权限
400001系统错误请稍后再试