淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
page	Number	必须	1	分页的页数,从1开始
size	Number	必须	10	每页数量
open_leads_id	String	可选	xyz	第三方商家的唯一线索编码
gmt_modified	Number	可选	1614150220570	增量时间戳,（依照最后更新时间增量），传该参数表示查询此时间戳之后修改过的所有符合条件的线索
gmt_create	Number	可选	1614150220570	增量时间戳,（依照创建时间增量），传该参数表示查询此时间戳之后修改过的所有符合条件的线索

名称	类型	示例值	描述
result	Result		result
└ message_flag Boolean true 是否成功 └ message_code Number 100399999 返回错误码 └ message_info String 程序发生异常错误message data OpenPagingWrapResult 返回结果 paging_data OpenPagingData 分页信息，嵌套类分页信息 └ page Number 1 分页的页数,从1开始 └ size Number 10 每页数量 └ total Number 100 总数 list LeadsResp [] 分页的具体数据 └ leads_id String u12abcd 线索id └ open_leads_id String xyz 第三方商家的唯一线索编码 └ customer_name String xxxxx 客户姓名 └ community_name String 新月小区小区名称 └ design_id String ef7c6a5e-787c-4693- 方案id └ gmt_modified Number 线索最后更新时间 1614150220570 └ gmt_create Number 线索创建时间 1614150220570

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDecorationLeadsListRequest req = new AlibabaDecorationLeadsListRequest();
req.setPage(1L);
req.setSize(10L);
req.setOpenLeadsId("xyz");
req.setGmtModified(1614150220570L);
req.setGmtCreate(1614150220570L);
AlibabaDecorationLeadsListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDecorationLeadsListRequest req = new AlibabaDecorationLeadsListRequest();
req.Page = 1L;
req.Size = 10L;
req.OpenLeadsId = "xyz";
req.GmtModified = 1614150220570L;
req.GmtCreate = 1614150220570L;
AlibabaDecorationLeadsListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDecorationLeadsListRequest;
$req->setPage("1");
$req->setSize("10");
$req->setOpenLeadsId("xyz");
$req->setGmtModified("1614150220570");
$req->setGmtCreate("1614150220570");
$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.decoration.leads.list' \
-d 'partner_id=apidoc' \
-d 'sign=65D7C64E800B691D2F6F2FFFB2831CB5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+15%3A43%3A58' \
-d 'v=2.0' \
-d 'gmt_create=1614150220570' \
-d 'gmt_modified=1614150220570' \
-d 'open_leads_id=xyz' \
-d 'page=1' \
-d 'size=10'

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

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

req.page=1
req.size=10
req.open_leads_id="xyz"
req.gmt_modified=1614150220570
req.gmt_create=1614150220570
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.decoration.leads.list");
add_param(pRequest,"page","1");
add_param(pRequest,"size","10");
add_param(pRequest,"open_leads_id","xyz");
add_param(pRequest,"gmt_modified","1614150220570");
add_param(pRequest,"gmt_create","1614150220570");
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.decoration.leads.list', {
	'page':'1',
	'size':'10',
	'open_leads_id':'xyz',
	'gmt_modified':'1614150220570',
	'gmt_create':'1614150220570'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_decoration_leads_list_response>
    <result>
        <message_flag>true</message_flag>
        <message_code>100399999</message_code>
        <message_info>程序发生异常</message_info>
        <data>
            <paging_data>
                <page>1</page>
                <size>10</size>
                <total>100</total>
            </paging_data>
            <list>
                <leads_resp>
                    <leads_id>u12abcd</leads_id>
                    <open_leads_id>xyz</open_leads_id>
                    <customer_name>xxxxx</customer_name>
                    <community_name>新月小区</community_name>
                    <design_id>ef7c6a5e-787c-4693-</design_id>
                    <gmt_modified>线索最后更新时间</gmt_modified>
                    <gmt_create>线索创建时间</gmt_create>
                </leads_resp>
            </list>
        </data>
    </result>
</alibaba_decoration_leads_list_response>

{
    "alibaba_decoration_leads_list_response":{
        "result":{
            "message_flag":true,
            "message_code":100399999,
            "message_info":"程序发生异常",
            "data":{
                "paging_data":{
                    "page":1,
                    "size":10,
                    "total":100
                },
                "list":{
                    "leads_resp":[
                        {
                            "leads_id":"u12abcd",
                            "open_leads_id":"xyz",
                            "customer_name":"xxxxx",
                            "community_name":"新月小区",
                            "design_id":"ef7c6a5e-787c-4693-",
                            "gmt_modified":线索最后更新时间,
                            "gmt_create":线索创建时间
                        }
                    ]
                }
            }
        }
    }
}

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下载

开放平台

装企端

alibaba.decoration.leads.list (获取企业线索列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ