阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
app_auth_dto	AppAuthDTO	必须		API调用租户身份鉴权
└ authkey String 必须 VALVRRJR 权限key └ code String 必须 12345454 权限code
operator	String	必须	sys	系统名称
leads_form_info_dto	LeadsFormInfoDTO	必须		leads信息补全DTO
└ country String 可选中国国家名称 └ action_time String 可选 2022-05-17 10:58:08 外呼时间 └ code String 可选示例当前表单的来源文章唯一code或者id └ city String 可选杭州城市名称 └ biz_code String 必须 other other系统值 └ fire_time Date 可选 2022-05-17 10:58:08 注册时间 └ origin String 必须 34 leads来源 └ company_name String 必须阿里巴巴公司名称 └ industry String 可选 123 当前表单的来源文章唯一code或者id └ title String 可选 123 当前表单的来源页面的名称 └ social_credit_code String 可选 2142154124 社会统一信用代码 └ device_id String 可选 1323 分发id └ object_type String 可选 123 打标对象类型 └ industry_code String 可选 22412 类目id └ ali_id String 可选 2154353252352 阿里id └ ext_map String 必须 { "address": "日土县迎宾路4号(测试)", "productId": "CGS_LEADS", "mobileNumber": "15900005", "companyName": "创建联系人公司", "origin": "62", "contactPerson": "大博报", "inputGlobalId": "4037898073", "phoneCountry": "86", "path": "", "phoneNumber": "1590", "mobileCountry": "86", "joinSource": "test", "countryName": "中国", "mainProduct": "金属冲压，钣金，数控加工" } 外呼额外信息 └ province String 可选浙江省 └ mbr_id String 可选 221412412 会员id └ street String 可选云杉郡1到123 街道 └ contact String 必须张三联系人姓名 └ cna String 可选 123 后台标号 └ inviter String 可选当前表单实际邀请人当前表单实际邀请人 └ id Number 可选 24124141 客户id └ email String 可选 214241@qq.com 邮箱 └ cn_country String 可选中国 oc的国家名称 └ os String 可选操作系统操作系统 └ company_type String 可选公司类型公司类型 └ leads_from_type String 必须业务线 CGS └ global_id String 必须 2523523523 客户唯一id └ biz_scene String 必须 other other └ event_type String 可选 123 当前表单触点动作类型 └ terminal String 可选终端类型终端类型 └ cn_city String 可选杭州中国城市 └ url String 可选当前表单的来源地址当前表单的来源地址 └ cn_street String 可选云杉郡1到123 中文街道名称 └ mobile_phone String 必须 1379988878 联系方式 └ cn_province String 可选浙江中文省 └ district String 可选 23124 街道code └ detail_address String 可选滨江区阿里巴巴详细地址信息 └ cn_district String 可选滨江区中文地区
param3	Boolean	必须	true	other

名称	类型	示例值	描述
sys_msg	String	系统错误	错误描述
sys_code	Number	3001	错误code
sys_success	Boolean	false	是否上报成功
sys_data	Number	241982479237593	leads线索id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCrmLeadsCreateRequest req = new AlibabaCrmLeadsCreateRequest();
AlibabaCrmLeadsCreateRequest.AppAuthDTO obj1 = new AlibabaCrmLeadsCreateRequest.AppAuthDTO();
obj1.setAuthkey("VALVRRJR");
obj1.setCode("12345454");
req.setAppAuthDto(obj1);
req.setOperator("sys");
AlibabaCrmLeadsCreateRequest.LeadsFormInfoDTO obj2 = new AlibabaCrmLeadsCreateRequest.LeadsFormInfoDTO();
obj2.setCountry("中国");
obj2.setActionTime("2022-05-17 10:58:08");
obj2.setCode("示例");
obj2.setCity("杭州");
obj2.setBizCode("other");
obj2.setFireTime(StringUtils.parseDateTime("2022-05-17 10:58:08"));
obj2.setOrigin("34");
obj2.setCompanyName("阿里巴巴");
obj2.setIndustry("123");
obj2.setTitle("123");
obj2.setSocialCreditCode("2142154124");
obj2.setDeviceId("1323");
obj2.setObjectType("123");
obj2.setIndustryCode("22412");
obj2.setAliId("2154353252352");
obj2.setExtMap("{       \"address\": \"日土县迎宾路4号(测试)\",       \"productId\": \"CGS_LEADS\",       \"mobileNumber\": \"15900005\",       \"companyName\": \"创建联系人公司\",       \"origin\": \"62\",       \"contactPerson\": \"大博报\",       \"inputGlobalId\": \"4037898073\",       \"phoneCountry\": \"86\",       \"path\": \"\",       \"phoneNumber\": \"1590\",       \"mobileCountry\": \"86\",       \"joinSource\": \"test\",       \"countryName\": \"中国\",       \"mainProduct\": \"金属冲压，钣金，数控加工\"     }");
obj2.setProvince("浙江");
obj2.setMbrId("221412412");
obj2.setStreet("云杉郡1到123");
obj2.setContact("张三");
obj2.setCna("123");
obj2.setInviter("当前表单实际邀请人");
obj2.setId(24124141L);
obj2.setEmail("214241@qq.com");
obj2.setCnCountry("中国");
obj2.setOs("操作系统");
obj2.setCompanyType("公司类型");
obj2.setLeadsFromType("业务线");
obj2.setGlobalId("2523523523");
obj2.setBizScene("other");
obj2.setEventType("123");
obj2.setTerminal("终端类型");
obj2.setCnCity("杭州");
obj2.setUrl("当前表单的来源地址");
obj2.setCnStreet("云杉郡1到123");
obj2.setMobilePhone("1379988878");
obj2.setCnProvince("浙江");
obj2.setDistrict("23124");
obj2.setDetailAddress("滨江区阿里巴巴");
obj2.setCnDistrict("滨江区");
req.setLeadsFormInfoDto(obj2);
req.setParam3(true);
AlibabaCrmLeadsCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCrmLeadsCreateRequest req = new AlibabaCrmLeadsCreateRequest();
AlibabaCrmLeadsCreateRequest.AppAuthDTODomain obj1 = new AlibabaCrmLeadsCreateRequest.AppAuthDTODomain();
obj1.Authkey = "VALVRRJR";
obj1.Code = "12345454";
req.AppAuthDto_ = obj1;
req.Operator = "sys";
AlibabaCrmLeadsCreateRequest.LeadsFormInfoDTODomain obj2 = new AlibabaCrmLeadsCreateRequest.LeadsFormInfoDTODomain();
obj2.Country = "中国";
obj2.ActionTime = "2022-05-17 10:58:08";
obj2.Code = "示例";
obj2.City = "杭州";
obj2.BizCode = "other";
obj2.FireTime = DateTime.Parse(2022-05-17 10:58:08");
obj2.Origin = "34";
obj2.CompanyName = "阿里巴巴";
obj2.Industry = "123";
obj2.Title = "123";
obj2.SocialCreditCode = "2142154124";
obj2.DeviceId = "1323";
obj2.ObjectType = "123";
obj2.IndustryCode = "22412";
obj2.AliId = "2154353252352";
obj2.ExtMap = "{       \"address\": \"日土县迎宾路4号(测试)\",       \"productId\": \"CGS_LEADS\",       \"mobileNumber\": \"15900005\",       \"companyName\": \"创建联系人公司\",       \"origin\": \"62\",       \"contactPerson\": \"大博报\",       \"inputGlobalId\": \"4037898073\",       \"phoneCountry\": \"86\",       \"path\": \"\",       \"phoneNumber\": \"1590\",       \"mobileCountry\": \"86\",       \"joinSource\": \"test\",       \"countryName\": \"中国\",       \"mainProduct\": \"金属冲压，钣金，数控加工\"     }";
obj2.Province = "浙江";
obj2.MbrId = "221412412";
obj2.Street = "云杉郡1到123";
obj2.Contact = "张三";
obj2.Cna = "123";
obj2.Inviter = "当前表单实际邀请人";
obj2.Id = 24124141L;
obj2.Email = "214241@qq.com";
obj2.CnCountry = "中国";
obj2.Os = "操作系统";
obj2.CompanyType = "公司类型";
obj2.LeadsFromType = "业务线";
obj2.GlobalId = "2523523523";
obj2.BizScene = "other";
obj2.EventType = "123";
obj2.Terminal = "终端类型";
obj2.CnCity = "杭州";
obj2.Url = "当前表单的来源地址";
obj2.CnStreet = "云杉郡1到123";
obj2.MobilePhone = "1379988878";
obj2.CnProvince = "浙江";
obj2.District = "23124";
obj2.DetailAddress = "滨江区阿里巴巴";
obj2.CnDistrict = "滨江区";
req.LeadsFormInfoDto_ = obj2;
req.Param3 = true;
AlibabaCrmLeadsCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCrmLeadsCreateRequest;
$app_auth_dto = new AppAuthDTO;
$app_auth_dto->authkey="VALVRRJR";
$app_auth_dto->code="12345454";
$req->setAppAuthDto(json_encode($app_auth_dto));
$req->setOperator("sys");
$leads_form_info_dto = new LeadsFormInfoDTO;
$leads_form_info_dto->country="中国";
$leads_form_info_dto->action_time="2022-05-17 10:58:08";
$leads_form_info_dto->code="示例";
$leads_form_info_dto->city="杭州";
$leads_form_info_dto->biz_code="other";
$leads_form_info_dto->fire_time="2022-05-17 10:58:08";
$leads_form_info_dto->origin="34";
$leads_form_info_dto->company_name="阿里巴巴";
$leads_form_info_dto->industry="123";
$leads_form_info_dto->title="123";
$leads_form_info_dto->social_credit_code="2142154124";
$leads_form_info_dto->device_id="1323";
$leads_form_info_dto->object_type="123";
$leads_form_info_dto->industry_code="22412";
$leads_form_info_dto->ali_id="2154353252352";
$leads_form_info_dto->ext_map="{       \"address\": \"日土县迎宾路4号(测试)\",       \"productId\": \"CGS_LEADS\",       \"mobileNumber\": \"15900005\",       \"companyName\": \"创建联系人公司\",       \"origin\": \"62\",       \"contactPerson\": \"大博报\",       \"inputGlobalId\": \"4037898073\",       \"phoneCountry\": \"86\",       \"path\": \"\",       \"phoneNumber\": \"1590\",       \"mobileCountry\": \"86\",       \"joinSource\": \"test\",       \"countryName\": \"中国\",       \"mainProduct\": \"金属冲压，钣金，数控加工\"     }";
$leads_form_info_dto->province="浙江";
$leads_form_info_dto->mbr_id="221412412";
$leads_form_info_dto->street="云杉郡1到123";
$leads_form_info_dto->contact="张三";
$leads_form_info_dto->cna="123";
$leads_form_info_dto->inviter="当前表单实际邀请人";
$leads_form_info_dto->id="24124141";
$leads_form_info_dto->email="214241@qq.com";
$leads_form_info_dto->cn_country="中国";
$leads_form_info_dto->os="操作系统";
$leads_form_info_dto->company_type="公司类型";
$leads_form_info_dto->leads_from_type="业务线";
$leads_form_info_dto->global_id="2523523523";
$leads_form_info_dto->biz_scene="other";
$leads_form_info_dto->event_type="123";
$leads_form_info_dto->terminal="终端类型";
$leads_form_info_dto->cn_city="杭州";
$leads_form_info_dto->url="当前表单的来源地址";
$leads_form_info_dto->cn_street="云杉郡1到123";
$leads_form_info_dto->mobile_phone="1379988878";
$leads_form_info_dto->cn_province="浙江";
$leads_form_info_dto->district="23124";
$leads_form_info_dto->detail_address="滨江区阿里巴巴";
$leads_form_info_dto->cn_district="滨江区";
$req->setLeadsFormInfoDto(json_encode($leads_form_info_dto));
$req->setParam3("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.leads.create' \
-d 'partner_id=apidoc' \
-d 'sign=14C88B53CF55F12E0CC46A45A4550157' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+18%3A23%3A57' \
-d 'v=2.0' \
-d 'app_auth_dto=null' \
-d 'leads_form_info_dto=null' \
-d 'operator=sys' \
-d 'param3=true'

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

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

req.app_auth_dto="数据结构示例JSON格式"
req.operator="sys"
req.leads_form_info_dto="数据结构示例JSON格式"
req.param3=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.leads.create");
add_param(pRequest,"app_auth_dto","数据结构JSON示例");
add_param(pRequest,"operator","sys");
add_param(pRequest,"leads_form_info_dto","数据结构JSON示例");
add_param(pRequest,"param3","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.leads.create', {
	'app_auth_dto':'数据结构JSON示例',
	'operator':'sys',
	'leads_form_info_dto':'数据结构JSON示例',
	'param3':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_crm_leads_create_response>
    <sys_msg>系统错误</sys_msg>
    <sys_code>3001</sys_code>
    <sys_success>false</sys_success>
    <sys_data>241982479237593</sys_data>
</alibaba_crm_leads_create_response>

{
    "alibaba_crm_leads_create_response":{
        "sys_msg":"系统错误",
        "sys_code":3001,
        "sys_success":false,
        "sys_data":241982479237593
    }
}

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.leads.create (外呼意愿度leads上报接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈