淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
auth	AppAuthDTO	必须		账号信息
└ authkey String 必须 111 authKey └ code String 必须 2333 code
operator	String	必须	xiaoman	操作人
leads_form_info_dto	LeadsFormInfoDTO	必须		leads信息
└ country String 可选中国国家 └ code String 可选 fff 当前表单的来源文章唯一code或者id └ city String 可选杭州城市 └ biz_code String 必须 other 可默认写死other └ origin String 必须 212 leads来源 └ company_name String 可选阿里巴巴公司公司名称 └ industry String 可选服装行业信息 └ social_credit_code String 可选 112dfefe 统一社会信用代码 └ device_id String 可选 222 设备号 └ object_type String 可选 - 当前表单的来触点类型 └ industry_code String 可选 23 行业code └ ali_id String 可选 2222 aliId └ ext_map String 可选 {"aa":"220140789"} 扩展信息 └ province String 可选浙江省省份 └ mbr_id String 可选 cn33ff 会员id └ street String 可选网商路699号街道 └ contact String 必须 - 联系人信息，不能为null，可以为空字符串 └ inviter String 可选 zyz.ss 邀约人，可以是销售id └ email String 可选 aaa@163.com 邮箱 └ cn_country String 可选 122 菜鸟国家码 └ leads_from_type String 可选 CGS 当前表单来源官网，值目前为：CGS、GGS └ global_id String 可选 2222 globalId，激活情况下填写 └ biz_scene String 可选 ohter 通用场景时雨讴明OTHER("其他", "ohter") └ cn_city String 可选 333 城市菜鸟code └ url String 可选 http://22.com 当前表单的来源地址 └ cn_street String 可选 44 街道菜鸟code └ mobile_phone String 可选 1301232345 联系人手机号 └ cn_province String 可选 555 省份菜鸟code └ district String 可选无常街道街道 └ detail_address String 可选网商路699号详细地址 └ cn_district String 可选菜鸟code 街道菜鸟code
add_leads	Boolean	可选	true	是否创建leads，true为创建，false为不创建

名称	类型	示例值	描述
message	String	系统异常等信息	错误结果
msg_code	Number	0	错误码
is_success	Boolean	ture	是否调用成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCrmHelicarrierDataServiceAddLeadsRequest req = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest();
AlibabaCrmHelicarrierDataServiceAddLeadsRequest.AppAuthDTO obj1 = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest.AppAuthDTO();
obj1.setAuthkey("111");
obj1.setCode("2333");
req.setAuth(obj1);
req.setOperator("xiaoman");
AlibabaCrmHelicarrierDataServiceAddLeadsRequest.LeadsFormInfoDTO obj2 = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest.LeadsFormInfoDTO();
obj2.setCountry("中国");
obj2.setCode("fff");
obj2.setCity("杭州");
obj2.setBizCode("other");
obj2.setOrigin("212");
obj2.setCompanyName("阿里巴巴公司");
obj2.setIndustry("服装");
obj2.setSocialCreditCode("112dfefe");
obj2.setDeviceId("222");
obj2.setObjectType("-");
obj2.setIndustryCode("23");
obj2.setAliId("2222");
obj2.setExtMap("{\"aa\":\"220140789\"}");
obj2.setProvince("浙江省");
obj2.setMbrId("cn33ff");
obj2.setStreet("网商路699号");
obj2.setContact("-");
obj2.setInviter("zyz.ss");
obj2.setEmail("aaa@163.com");
obj2.setCnCountry("122");
obj2.setLeadsFromType("CGS");
obj2.setGlobalId("2222");
obj2.setBizScene("ohter");
obj2.setCnCity("333");
obj2.setUrl("http://22.com");
obj2.setCnStreet("44");
obj2.setMobilePhone("1301232345");
obj2.setCnProvince("555");
obj2.setDistrict("无常街道");
obj2.setDetailAddress("网商路699号");
obj2.setCnDistrict("菜鸟code");
req.setLeadsFormInfoDto(obj2);
req.setAddLeads(true);
AlibabaCrmHelicarrierDataServiceAddLeadsResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCrmHelicarrierDataServiceAddLeadsRequest req = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest();
AlibabaCrmHelicarrierDataServiceAddLeadsRequest.AppAuthDTODomain obj1 = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest.AppAuthDTODomain();
obj1.Authkey = "111";
obj1.Code = "2333";
req.Auth_ = obj1;
req.Operator = "xiaoman";
AlibabaCrmHelicarrierDataServiceAddLeadsRequest.LeadsFormInfoDTODomain obj2 = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest.LeadsFormInfoDTODomain();
obj2.Country = "中国";
obj2.Code = "fff";
obj2.City = "杭州";
obj2.BizCode = "other";
obj2.Origin = "212";
obj2.CompanyName = "阿里巴巴公司";
obj2.Industry = "服装";
obj2.SocialCreditCode = "112dfefe";
obj2.DeviceId = "222";
obj2.ObjectType = "-";
obj2.IndustryCode = "23";
obj2.AliId = "2222";
obj2.ExtMap = "{\"aa\":\"220140789\"}";
obj2.Province = "浙江省";
obj2.MbrId = "cn33ff";
obj2.Street = "网商路699号";
obj2.Contact = "-";
obj2.Inviter = "zyz.ss";
obj2.Email = "aaa@163.com";
obj2.CnCountry = "122";
obj2.LeadsFromType = "CGS";
obj2.GlobalId = "2222";
obj2.BizScene = "ohter";
obj2.CnCity = "333";
obj2.Url = "http://22.com";
obj2.CnStreet = "44";
obj2.MobilePhone = "1301232345";
obj2.CnProvince = "555";
obj2.District = "无常街道";
obj2.DetailAddress = "网商路699号";
obj2.CnDistrict = "菜鸟code";
req.LeadsFormInfoDto_ = obj2;
req.AddLeads = true;
AlibabaCrmHelicarrierDataServiceAddLeadsResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCrmHelicarrierDataServiceAddLeadsRequest;
$auth = new AppAuthDTO;
$auth->authkey="111";
$auth->code="2333";
$req->setAuth(json_encode($auth));
$req->setOperator("xiaoman");
$leads_form_info_dto = new LeadsFormInfoDTO;
$leads_form_info_dto->country="中国";
$leads_form_info_dto->code="fff";
$leads_form_info_dto->city="杭州";
$leads_form_info_dto->biz_code="other";
$leads_form_info_dto->origin="212";
$leads_form_info_dto->company_name="阿里巴巴公司";
$leads_form_info_dto->industry="服装";
$leads_form_info_dto->social_credit_code="112dfefe";
$leads_form_info_dto->device_id="222";
$leads_form_info_dto->object_type="-";
$leads_form_info_dto->industry_code="23";
$leads_form_info_dto->ali_id="2222";
$leads_form_info_dto->ext_map="{\"aa\":\"220140789\"}";
$leads_form_info_dto->province="浙江省";
$leads_form_info_dto->mbr_id="cn33ff";
$leads_form_info_dto->street="网商路699号";
$leads_form_info_dto->contact="-";
$leads_form_info_dto->inviter="zyz.ss";
$leads_form_info_dto->email="aaa@163.com";
$leads_form_info_dto->cn_country="122";
$leads_form_info_dto->leads_from_type="CGS";
$leads_form_info_dto->global_id="2222";
$leads_form_info_dto->biz_scene="ohter";
$leads_form_info_dto->cn_city="333";
$leads_form_info_dto->url="http://22.com";
$leads_form_info_dto->cn_street="44";
$leads_form_info_dto->mobile_phone="1301232345";
$leads_form_info_dto->cn_province="555";
$leads_form_info_dto->district="无常街道";
$leads_form_info_dto->detail_address="网商路699号";
$leads_form_info_dto->cn_district="菜鸟code";
$req->setLeadsFormInfoDto(json_encode($leads_form_info_dto));
$req->setAddLeads("true");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.crm.helicarrier.data.service.add.leads' \
-d 'partner_id=apidoc' \
-d 'sign=50C2C1B80F66C4A1AAB916666D1255FF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+21%3A21%3A09' \
-d 'v=2.0' \
-d 'add_leads=true' \
-d 'auth=null' \
-d 'leads_form_info_dto=null' \
-d 'operator=xiaoman'

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

req=top.api.AlibabaCrmHelicarrierDataServiceAddLeadsRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.auth="数据结构示例JSON格式"
req.operator="xiaoman"
req.leads_form_info_dto="数据结构示例JSON格式"
req.add_leads=true
try:
	resp= req.getResponse()
	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,"alibaba.crm.helicarrier.data.service.add.leads");
add_param(pRequest,"auth","数据结构JSON示例");
add_param(pRequest,"operator","xiaoman");
add_param(pRequest,"leads_form_info_dto","数据结构JSON示例");
add_param(pRequest,"add_leads","true");
pResponse = top_execute(pClient,pRequest,NULL);
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('alibaba.crm.helicarrier.data.service.add.leads', {
	'auth':'数据结构JSON示例',
	'operator':'xiaoman',
	'leads_form_info_dto':'数据结构JSON示例',
	'add_leads':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_crm_helicarrier_data_service_add_leads_response>
    <message>系统异常等信息</message>
    <msg_code>0</msg_code>
    <is_success>ture</is_success>
</alibaba_crm_helicarrier_data_service_add_leads_response>

{
    "alibaba_crm_helicarrier_data_service_add_leads_response":{
        "message":"系统异常等信息",
        "msg_code":0,
        "is_success":ture
    }
}

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

错误码	错误描述	解决方案

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

CRM猎户座前台

alibaba.crm.helicarrier.data.service.add.leads (外部对接生成leads)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ