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

dingtalk.corp.ext.add (添加企业外部联系人)

钉钉企业外部通讯录, 添加外部联系人

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
contact	OpenExtContact	必须			外部联系人信息
└ title String 可选开发工程师职位 └ share_deptids Number [] 可选 [1,2,3] 共享给的部门ID └ label_ids Number [] 必须 [1,2,3] 标签列表 └ remark String 可选备注内容备注 └ address String 可选地址内容地址 └ name String 必须张三名称 └ follower_userid String 必须 023420013645 负责人userId └ state_code String 必须 86 手机号国家码 └ company_name String 可选钉钉企业名 └ share_userids String [] 可选 ["023420013644"] 共享给的员工userId列表 └ mobile String 必须 1308888888 手机号

响应参数

名称	类型	示例值	描述
userid	String	123420013632	新外部联系人的userId

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpExtAddRequest req = new CorpExtAddRequest();
OpenExtContact obj1 = new OpenExtContact();
obj1.setTitle("开发工程师");
obj1.setShareDeptids(new Long[] { 1,2,3 };
);
obj1.setLabelIds(new Long[] { 1,2,3 };
);
obj1.setRemark("备注内容");
obj1.setAddress("地址内容");
obj1.setName("张三");
obj1.setFollowerUserid("023420013645");
obj1.setStateCode("86");
obj1.setCompanyName("钉钉");
obj1.setShareUserids(""023420013644"");
obj1.setMobile("1308888888");
req.setContact(obj1);
CorpExtAddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpExtAddRequest req = new CorpExtAddRequest();
CorpExtAddRequest.OpenExtContactDomain obj1 = new CorpExtAddRequest.OpenExtContactDomain();
obj1.Title = "开发工程师";
obj1.ShareDeptids = new long[] { 1,2,3 };
;
obj1.LabelIds = new long[] { 1,2,3 };
;
obj1.Remark = "备注内容";
obj1.Address = "地址内容";
obj1.Name = "张三";
obj1.FollowerUserid = "023420013645";
obj1.StateCode = "86";
obj1.CompanyName = "钉钉";
obj1.ShareUserids = ""023420013644"";
obj1.Mobile = "1308888888";
req.Contact_ = obj1;
CorpExtAddResponse 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 CorpExtAddRequest;
$contact = new OpenExtContact;
$contact->title="开发工程师";
$contact->share_deptids="[1,2,3]";
$contact->label_ids="[1,2,3]";
$contact->remark="备注内容";
$contact->address="地址内容";
$contact->name="张三";
$contact->follower_userid="023420013645";
$contact->state_code="86";
$contact->company_name="钉钉";
$contact->share_userids="[\"023420013644\"]";
$contact->mobile="1308888888";
$req->setContact($contact);
$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.ext.add' \
-d 'partner_id=apidoc' \
-d 'session=374fa78a-608a-4a50-8f7a-19a57001314b' \
-d 'timestamp=2025-06-09+20%3A23%3A44' \
-d 'v=2.0' \
-d 'contact=null'

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

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

req.contact=""
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.ext.add");
add_param(pRequest,"contact","数据结构JSON示例");
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.ext.add', {
	'contact':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_ext_add_response>
    <userid>123420013632</userid>
</dingtalk_corp_ext_add_response>

{
    "dingtalk_corp_ext_add_response":{
        "userid":"123420013632"
    }
}

异常示例

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"
	}
}

错误码解释

错误码	错误描述	解决方案
60200	该用户是同企业同事, 无法加入外部通讯录	删除相应同事或修改外部联系人的手机号
60103	手机号码不合法	检查手机号格式
60201	该外部联系人已存在	无法继续添加
60203	外部联系人数量达到上限	删除其他外部联系人或者提升企业等级
60204	必须至少设置一个标签	设置标签

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

钉钉API

dingtalk.corp.ext.add (添加企业外部联系人)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈