Developer GuideRequest
| Basic information | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/extcontact/get |
| HTTP Method | POST |
| Supported app types | appType-Internal app, appType-Third-party enterprise app |
| Permissions | permission-qyapi_ext_read-Read permission for external contacts |
Query parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| access_token | String | Yes | bE74xxxx | The app credential used to call this API. - For an internal app, obtain it by calling the API for getting the access_token of an internal app. - For a third-party enterprise app, obtain it by calling the API for getting the access_token of a third-party enterprise. |
Request body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| user_id | String | Yes | 112500xxxx4889 | The user ID of the external contact. Call the Get the external contact list API to get the value of the userid parameter. |
Request example
curl -X POST "https://api.dingtalk.io/topapi/extcontact/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=53584xxxx2c50b' \
-d 'user_id=112500xxxx4889'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.setUserId("112500xxxx4889");
OapiExtcontactGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactGetRequest("https://api.dingtalk.io/topapi/extcontact/get")
req.user_id="112500xxxx4889"
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
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://api.dingtalk.io/topapi/extcontact/get");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.UserId = "112500xxxx4889";
OapiExtcontactGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Response
Response body
| Name | Type | Example | Description |
|---|---|---|---|
| result | OpenExtContact | The query result. | |
| title | String | Development Engineer | The job title. |
| share_dept_ids | Number[] | [1,2,3] | The list of shared department IDs. |
| label_ids | Number[] | [1,2,3] | The tags. |
| remark | String | Alias content | The alias. |
| address | String | Address content | The address. |
| name | String | Zhang San | The name. |
| follower_user_id | String | 6767531692 | The user ID of the owner. |
| state_code | String | 86 | The country code. |
| company_name | String | DingTalk | The company name. |
| share_user_ids | String[] | [“042059613752”] | The list of user IDs of shared employees. |
| mobile | String | 13088888888 | The mobile number. Note: This parameter is not returned for third-party enterprise apps. |
| userid | String | 0123456789 | The user ID of the external contact. |
| String | xxx@1.com | The email address. | |
| errcode | Number | 0 | The return code. |
| errmsg | String | ok | The description of the return code. |
| request_id | String | xrudojam4g8f | The request ID. |
Response example
{
"errcode":0,
"result":{
"share_user_ids":[
"66220007745510"
],
"follower_user_id":"manager4220",
"address":"Beijing",
"share_dept_ids":[],
"label_ids":[
1561077317
],
"share_dept_ids": [
42xxxx36
],
"mobile":"136***47616",
"remark":"Technical Lead",
"title":"CFO",
"userid":"011250026469774889",
"company_name":"DingTalk",
"name":"Manager Wang",
"state_code":"86",
"email":"zhang@example.com"
},
"request_id":"xrudojam4g8f"
}
Error codes
If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.| Error code (errcode) | Error message (errmsg) | Solution |
|---|---|---|
| 33009 | Invalid tokenGrantType | Check whether the access_token is correct. |
| 33012 | Invalid userId | Check whether the userId is correct. |
| 43007 | Operation permission required | Check whether the access_token has the required operation permissions. |
| 400001 | System error | Try again later. |