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

dingtalk.oapi.extcontact.create (添加企业外部联系人)

添加企业外部联系人

公共参数

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

请求参数

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

响应参数

名称	类型	示例值	描述
userid	String	123420013632	新外部联系人的userId
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/create");
OapiExtcontactCreateRequest req = new OapiExtcontactCreateRequest();
OpenExtContact obj1 = new OpenExtContact();
obj1.setTitle("开发工程师");
obj1.setLabelIds(new Long[] { 1,2,3 };
);
obj1.setShareDeptIds(new Long[] { 1,2,3 };
);
obj1.setAddress("地址内容");
obj1.setRemark("备注内容");
obj1.setFollowerUserId("023420013645");
obj1.setName("张三");
obj1.setStateCode("86");
obj1.setCompanyName("钉钉");
obj1.setShareUserIds(""023420013644"");
obj1.setMobile("13088888888");
req.setContact(obj1);
OapiExtcontactCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/extcontact/create");
OapiExtcontactCreateRequest req = new OapiExtcontactCreateRequest();
OapiExtcontactCreateRequest.OpenExtContactDomain obj1 = new OapiExtcontactCreateRequest.OpenExtContactDomain();
obj1.Title = "开发工程师";
obj1.LabelIds = new long[] { 1,2,3 };
;
obj1.ShareDeptIds = new long[] { 1,2,3 };
;
obj1.Address = "地址内容";
obj1.Remark = "备注内容";
obj1.FollowerUserId = "023420013645";
obj1.Name = "张三";
obj1.StateCode = "86";
obj1.CompanyName = "钉钉";
obj1.ShareUserIds = ""023420013644"";
obj1.Mobile = "13088888888";
req.Contact_ = obj1;
OapiExtcontactCreateResponse 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 OapiExtcontactCreateRequest;
$contact = new OpenExtContact;
$contact->title="开发工程师";
$contact->label_ids="[1,2,3]";
$contact->share_dept_ids="[1,2,3]";
$contact->address="地址内容";
$contact->remark="备注内容";
$contact->follower_user_id="023420013645";
$contact->name="张三";
$contact->state_code="86";
$contact->company_name="钉钉";
$contact->share_user_ids="[\"023420013644\"]";
$contact->mobile="13088888888";
$req->setContact($contact);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/extcontact/create");

curl -X POST "https://oapi.dingtalk.com/topapi/extcontact/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=8f60a2e4-f895-404e-8291-3d77a9711d02' \
-d 'contact=null'

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

req=dingtalk.api.OapiExtcontactCreateRequest("https://oapi.dingtalk.com/topapi/extcontact/create")

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.oapi.extcontact.create");
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.oapi.extcontact.create', {
	'contact':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "userid":"123420013632",
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.extcontact.create (添加企业外部联系人)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ