淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
leads_query_request	LeadsQueryRequest	必须			客资查询参数
└ gmt_end Date 必须 2022-06-01 00:00:00 查询时间范围结束时间（客资创建时间）,不能早于查询时间范围的开始时间，查询时间范围要在三个月之内（开始和结束时间的跨度），不能超过三个月 └ page_no Number 必须 1 分页参数页码，第几页，要大于0，必须是整数 └ page_size Number 必须 20 分页参数，每页查询数量大小，必须大于0，必须是整数，目前默认20，不能超过20 └ gmt_start Date 必须 2022-05-01 00:00:00 查询时间范围开始时间（客资创建时间）,不能早于2020-05-01 00:00:00

名称	类型	示例值	描述
data	LeadsDetailListResponse		客资查询结果
└ total_count Number 100 客资总数 leads_order_info_list LeadsDetailInfo [] 客资详情列表 └ is_x_phone Boolean false 表明该客资的号码是否是隐私客资 └ x_phone_effect_start Date 2022-05-18 15:48:27 隐私号生效开始时间 └ x_phone_effect_end Date 2022-10-18 15:48:27 隐私号生效截止时间 └ channel String 口碑客资渠道，例如口碑、支付宝、淘宝等 └ biz_type String 门店预约客资类型，如手艺人预约，直播客资，门店预约，商品购买等 └ scene_source String OTHER 来源场景 └ create_time Date 2022-07-18 15:48:27 客资创建时间 └ contact_name String caidou 用户姓名，如示例值展示 └ shop_id String 2019112000077000000084784952 口碑门店id └ shop_name String 蕉聿婚嫁测试(三店) 门店名称 └ leads_city String 上海市客资意向城市 └ leads_district String 普陀区客资意向地区 └ status String INIT 客资状态：INIT("待联系"), CONTACTED("已联系"), CANNOTCONTACTED("未接通"), ARRIVED("已到店"), TRADED("已交易"), NOINTENTION("无意向") └ is_answer String 是电话客资，是否接起，"是"或者"否"，仅电话客资会有值 └ feed_back_tag String WRONG_CITY 反馈类型： WRONG_CITY("WRONG_CITY", "城市不对"), WRONG_NUMBER("WRONG_NUMBER", "空号错号"), NO_ANSWERED("NO_ANSWERED", "无人接听"), SALES_CALL("SALES_CALL", "推销电话"), NO_LEADS("NO_LEADS", "用户未留资"), CALL_FORWARDED("CALL_FORWARDED", "呼叫被转移"), OTHER("OTHER", "其他") └ reservation_record_id String 20220704880000000000000042700295 客资记录id └ memo String 哈哈哈商家备注 └ shop_city String 杭州市门店所在城市 └ gift_name String 测试礼物领取的预约礼名称 └ camp_name String 测试活动参与的活动名称 └ item_name String 测试商品购买的商品名称 └ merchant_phone String 18251639674 指定商户号码，目前隐私号未AXB,必须用特定号码才能进行拨打 └ ext_info String {"userMemo":"{\"服务类型\":\"高德口腔测试数据\"}" } 扩展字段，如userMemo-客资信息, virtualNo--隐私号等 └ contact_mobile String 13312341233 用户手机号
is_success	Boolean	false	是否成功，true-成功，false-失败
error	TribeError		错误信息
└ code String 500 错误码 └ message String page_no必须为大于1的整数错误信息描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscKbLeadsRecordPagequeryRequest req = new AlibabaAlscKbLeadsRecordPagequeryRequest();
AlibabaAlscKbLeadsRecordPagequeryRequest.LeadsQueryRequest obj1 = new AlibabaAlscKbLeadsRecordPagequeryRequest.LeadsQueryRequest();
obj1.setGmtEnd(StringUtils.parseDateTime("2022-06-01 00:00:00"));
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setGmtStart(StringUtils.parseDateTime("2022-05-01 00:00:00"));
req.setLeadsQueryRequest(obj1);
AlibabaAlscKbLeadsRecordPagequeryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscKbLeadsRecordPagequeryRequest req = new AlibabaAlscKbLeadsRecordPagequeryRequest();
AlibabaAlscKbLeadsRecordPagequeryRequest.LeadsQueryRequestDomain obj1 = new AlibabaAlscKbLeadsRecordPagequeryRequest.LeadsQueryRequestDomain();
obj1.GmtEnd = DateTime.Parse(2022-06-01 00:00:00");
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.GmtStart = DateTime.Parse(2022-05-01 00:00:00");
req.LeadsQueryRequest_ = obj1;
AlibabaAlscKbLeadsRecordPagequeryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscKbLeadsRecordPagequeryRequest;
$leads_query_request = new LeadsQueryRequest;
$leads_query_request->gmt_end="2022-06-01 00:00:00";
$leads_query_request->page_no="1";
$leads_query_request->page_size="20";
$leads_query_request->gmt_start="2022-05-01 00:00:00";
$req->setLeadsQueryRequest(json_encode($leads_query_request));
$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.alsc.kb.leads.record.pagequery' \
-d 'partner_id=apidoc' \
-d 'sign=9DC7B9E3123AAAEBB6AB96EEF612B0A3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-26+02%3A25%3A55' \
-d 'v=2.0' \
-d 'leads_query_request=null'

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

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

req.leads_query_request="数据结构示例JSON格式"
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.alsc.kb.leads.record.pagequery");
add_param(pRequest,"leads_query_request","数据结构JSON示例");
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.alsc.kb.leads.record.pagequery', {
	'leads_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_kb_leads_record_pagequery_response>
    <data>
        <total_count>100</total_count>
        <leads_order_info_list>
            <leads_detail_info>
                <is_x_phone>false</is_x_phone>
                <x_phone_effect_start>2022-05-18 15:48:27</x_phone_effect_start>
                <x_phone_effect_end>2022-10-18 15:48:27</x_phone_effect_end>
                <channel>口碑</channel>
                <biz_type>门店预约</biz_type>
                <scene_source>OTHER</scene_source>
                <create_time>2022-07-18 15:48:27</create_time>
                <contact_name>caidou</contact_name>
                <shop_id>2019112000077000000084784952</shop_id>
                <shop_name>蕉聿婚嫁测试(三店)</shop_name>
                <leads_city>上海市</leads_city>
                <leads_district>普陀区</leads_district>
                <status>INIT</status>
                <is_answer>是</is_answer>
                <feed_back_tag>WRONG_CITY</feed_back_tag>
                <reservation_record_id>20220704880000000000000042700295</reservation_record_id>
                <memo>哈哈哈</memo>
                <shop_city>杭州市</shop_city>
                <gift_name>测试礼物</gift_name>
                <camp_name>测试活动</camp_name>
                <item_name>测试商品</item_name>
                <merchant_phone>18251639674</merchant_phone>
                <ext_info>{&quot;userMemo&quot;:&quot;{\&quot;服务类型\&quot;:\&quot;高德口腔测试数据\&quot;}&quot; }</ext_info>
                <contact_mobile>13312341233</contact_mobile>
            </leads_detail_info>
        </leads_order_info_list>
    </data>
    <is_success>false</is_success>
    <error>
        <code>500</code>
        <message>page_no必须为大于1的整数</message>
    </error>
</alibaba_alsc_kb_leads_record_pagequery_response>

{
    "alibaba_alsc_kb_leads_record_pagequery_response":{
        "data":{
            "total_count":100,
            "leads_order_info_list":{
                "leads_detail_info":[
                    {
                        "is_x_phone":false,
                        "x_phone_effect_start":"2022-05-18 15:48:27",
                        "x_phone_effect_end":"2022-10-18 15:48:27",
                        "channel":"口碑",
                        "biz_type":"门店预约",
                        "scene_source":"OTHER",
                        "create_time":"2022-07-18 15:48:27",
                        "contact_name":"caidou",
                        "shop_id":"2019112000077000000084784952",
                        "shop_name":"蕉聿婚嫁测试(三店)",
                        "leads_city":"上海市",
                        "leads_district":"普陀区",
                        "status":"INIT",
                        "is_answer":"是",
                        "feed_back_tag":"WRONG_CITY",
                        "reservation_record_id":"20220704880000000000000042700295",
                        "memo":"哈哈哈",
                        "shop_city":"杭州市",
                        "gift_name":"测试礼物",
                        "camp_name":"测试活动",
                        "item_name":"测试商品",
                        "merchant_phone":"18251639674",
                        "ext_info":"{\"userMemo\":\"{\\\"服务类型\\\":\\\"高德口腔测试数据\\\"}\" }",
                        "contact_mobile":"13312341233"
                    }
                ]
            }
        },
        "is_success":false,
        "error":{
            "code":"500",
            "message":"page_no必须为大于1的整数"
        }
    }
}

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

本地生活客资平台-客资API

alibaba.alsc.kb.leads.record.pagequery (商户查询客资列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ