淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
customer_id_begin	String	必须	666		本次导入的第N次查询，客户id起始值
last_sync_end_time	Date	必须	2020-10-02 10:00:00		本次导入的其实查询时间
page_size	Number	可选	100	默认值：50	一页大小
start_time	Date	可选	2020-10-02 10:00:00		建档开始时间
end_time	Date	可选	2020-10-02 10:00:00		建档结束时间

名称	类型	示例值	描述
data_list	CustomerOpenDto []	客户列表	客户列表
address AddressCo 地址地址 └ city String 杭州城市 └ country String 中国国家 └ district String 滨江区地区 └ province String 浙江省份 └ street String 西兴街道 └ annual_procurement String BETWEEN_1K_AND_5K 年成交额 └ basic_info_allowable String n 基础信息不允许透出 └ business_type_list String [] 商业类型 └ company_name String 阿里巴巴公司名 └ contact_info_allowable String y 联系人信息允许透出 contact_open_co_list ContactOpenCo [] 联系人列表联系人列表 └ avatar_url String http://sc01.alicdn.com/kf/HTB1.uclJpXXXXXUXVXXq6xXFXXXL.jpg 头像url └ email_list String [] 123@qq.com 邮箱 └ encrypt_reference_id String MC1IDX1f7BwyKZpzFVl0Ns9hTFuY-BQKjop80UForamCwSvDHyJlHCLiFrNDChu3x4pcAdb 加密的买家accountId └ first_name String Jack 名 └ gender String M 性别F/M/其他 └ id String 33333 联系人id im_list ImsCo [] 社交账号社交账号 └ social_type String facebook 社交账号类型 └ social_value String xiaobei 社交账号值 └ is_main String y 是否主联系人 └ last_name String Green 姓 └ memo String 随时联系备注 mobile_list MobileCo [] 手机手机 └ mobile_country_code String 086 国家编号 └ mobile_phone_num String 13876541234 手机号 phone_number_list PhoneCo [] 电话号码电话号码 └ area_code String 0571 区号 └ country_code String 086 国家编号 └ ext String 1 分机号 └ number String 6788876 号码 └ position String 经理职位 └ reference_id String 123 客户对应买家accountId └ sec_token String xxx 将买家id和商家di加密 └ customer_id String 89898989 客户id └ customer_phase String ENQUIRY_GROUP 客户阶段 fax PhoneCo 086-0571-88888-1 传真 └ area_code String 0571 区号 └ country_code String 086 国家编号 └ ext String 1 分机号 └ number String 88888 号码 └ gmt_create String 2020-10-10 00:00:00 建档时间 └ importance_level String TWO_STAR 采购意向 └ owner_email String 567@123.com 业务员邮箱 └ owner_id_member_seq String 323232 业务员accountId └ purchase_category_list String [] [self_002134] 采购品类 └ remark String 备注备注 └ source_list String [] [inquiry] 客户来源 └ website String www.alibaba.com 客户网站 └ alicrm_customer_detail_url String https://alicrm.alibaba.com/#customer-detail?customerId=1234 客户详情页 └ in_protecting Boolean false 是否在待添加客户列表中 └ growth_level String L1+ 买家分层
total	Number	1000	总个数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaSellerCustomerBatchGetRequest req = new AlibabaSellerCustomerBatchGetRequest();
req.setCustomerIdBegin("666");
req.setLastSyncEndTime(StringUtils.parseDateTime("2020-10-02 10:00:00"));
req.setPageSize(100L);
req.setStartTime(StringUtils.parseDateTime("2020-10-02 10:00:00"));
req.setEndTime(StringUtils.parseDateTime("2020-10-02 10:00:00"));
AlibabaSellerCustomerBatchGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaSellerCustomerBatchGetRequest req = new AlibabaSellerCustomerBatchGetRequest();
req.CustomerIdBegin = "666";
req.LastSyncEndTime = DateTime.Parse("2020-10-02 10:00:00");
req.PageSize = 100L;
req.StartTime = DateTime.Parse("2020-10-02 10:00:00");
req.EndTime = DateTime.Parse("2020-10-02 10:00:00");
AlibabaSellerCustomerBatchGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaSellerCustomerBatchGetRequest;
$req->setCustomerIdBegin("666");
$req->setLastSyncEndTime("2020-10-02 10:00:00");
$req->setPageSize("100");
$req->setStartTime("2020-10-02 10:00:00");
$req->setEndTime("2020-10-02 10:00:00");
$resp = $c->execute($req, $sessionKey);

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.seller.customer.batch.get' \
-d 'partner_id=apidoc' \
-d 'session=af9123a3-1c7a-4a9c-89c0-b05973efe253' \
-d 'sign=81A94082F63A54B7521F13C340CE182E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-27+07%3A36%3A38' \
-d 'v=2.0' \
-d 'customer_id_begin=666' \
-d 'end_time=2020-10-02+10%3A00%3A00' \
-d 'last_sync_end_time=2020-10-02+10%3A00%3A00' \
-d 'page_size=100' \
-d 'start_time=2020-10-02+10%3A00%3A00'

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

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

req.customer_id_begin="666"
req.last_sync_end_time="2020-10-02 10:00:00"
req.page_size=100
req.start_time="2020-10-02 10:00:00"
req.end_time="2020-10-02 10:00:00"
try:
	resp= req.getResponse(sessionkey)
	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.seller.customer.batch.get");
add_param(pRequest,"customer_id_begin","666");
add_param(pRequest,"last_sync_end_time","2020-10-02 10:00:00");
add_param(pRequest,"page_size","100");
add_param(pRequest,"start_time","2020-10-02 10:00:00");
add_param(pRequest,"end_time","2020-10-02 10:00:00");
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('alibaba.seller.customer.batch.get', {
	'customer_id_begin':'666',
	'last_sync_end_time':'2020-10-02 10:00:00',
	'page_size':'100',
	'start_time':'2020-10-02 10:00:00',
	'end_time':'2020-10-02 10:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_seller_customer_batch_get_response>
    <data_list>
        <customer_open_dto>
            <address>
                <city>杭州</city>
                <country>中国</country>
                <district>滨江区</district>
                <province>浙江</province>
                <street>西兴</street>
            </address>
            <annual_procurement>BETWEEN_1K_AND_5K</annual_procurement>
            <basic_info_allowable>n</basic_info_allowable>
            <business_type_list>
                <string></string>
            </business_type_list>
            <company_name>阿里巴巴</company_name>
            <contact_info_allowable>y</contact_info_allowable>
            <contact_open_co_list>
                <contact_open_co>
                    <avatar_url>http://sc01.alicdn.com/kf/HTB1.uclJpXXXXXUXVXXq6xXFXXXL.jpg</avatar_url>
                    <email_list>
                        <string>123@qq.com</string>
                    </email_list>
                    <encrypt_reference_id>MC1IDX1f7BwyKZpzFVl0Ns9hTFuY-BQKjop80UForamCwSvDHyJlHCLiFrNDChu3x4pcAdb</encrypt_reference_id>
                    <first_name>Jack</first_name>
                    <gender>M</gender>
                    <id>33333</id>
                    <im_list>
                        <ims_co>
                            <social_type>facebook</social_type>
                            <social_value>xiaobei</social_value>
                        </ims_co>
                    </im_list>
                    <is_main>y</is_main>
                    <last_name>Green</last_name>
                    <memo>随时联系</memo>
                    <mobile_list>
                        <mobile_co>
                            <mobile_country_code>086</mobile_country_code>
                            <mobile_phone_num>13876541234</mobile_phone_num>
                        </mobile_co>
                    </mobile_list>
                    <phone_number_list>
                        <phone_co>
                            <area_code>0571</area_code>
                            <country_code>086</country_code>
                            <ext>1</ext>
                            <number>6788876</number>
                        </phone_co>
                    </phone_number_list>
                    <position>经理</position>
                    <reference_id>123</reference_id>
                    <sec_token>xxx</sec_token>
                </contact_open_co>
            </contact_open_co_list>
            <customer_id>89898989</customer_id>
            <customer_phase>ENQUIRY_GROUP</customer_phase>
            <fax>
                <area_code>0571</area_code>
                <country_code>086</country_code>
                <ext>1</ext>
                <number>88888</number>
            </fax>
            <gmt_create>2020-10-10 00:00:00</gmt_create>
            <importance_level>TWO_STAR</importance_level>
            <owner_email>567@123.com</owner_email>
            <owner_id_member_seq>323232</owner_id_member_seq>
            <purchase_category_list>
                <string>[self_002134]</string>
            </purchase_category_list>
            <remark>备注</remark>
            <source_list>
                <string>[inquiry]</string>
            </source_list>
            <website>www.alibaba.com</website>
            <alicrm_customer_detail_url>https://alicrm.alibaba.com/#customer-detail?customerId=1234</alicrm_customer_detail_url>
            <in_protecting>false</in_protecting>
            <growth_level>L1+</growth_level>
        </customer_open_dto>
    </data_list>
    <total>1000</total>
</alibaba_seller_customer_batch_get_response>

{
    "alibaba_seller_customer_batch_get_response":{
        "data_list":{
            "customer_open_dto":[
                {
                    "address":{
                        "city":"杭州",
                        "country":"中国",
                        "district":"滨江区",
                        "province":"浙江",
                        "street":"西兴"
                    },
                    "annual_procurement":"BETWEEN_1K_AND_5K",
                    "basic_info_allowable":"n",
                    "business_type_list":{
                        "string":[
                            ""
                        ]
                    },
                    "company_name":"阿里巴巴",
                    "contact_info_allowable":"y",
                    "contact_open_co_list":{
                        "contact_open_co":[
                            {
                                "avatar_url":"http:\/\/sc01.alicdn.com\/kf\/HTB1.uclJpXXXXXUXVXXq6xXFXXXL.jpg",
                                "email_list":{
                                    "string":[
                                        "123@qq.com"
                                    ]
                                },
                                "encrypt_reference_id":"MC1IDX1f7BwyKZpzFVl0Ns9hTFuY-BQKjop80UForamCwSvDHyJlHCLiFrNDChu3x4pcAdb",
                                "first_name":"Jack",
                                "gender":"M",
                                "id":"33333",
                                "im_list":{
                                    "ims_co":[
                                        {
                                            "social_type":"facebook",
                                            "social_value":"xiaobei"
                                        }
                                    ]
                                },
                                "is_main":"y",
                                "last_name":"Green",
                                "memo":"随时联系",
                                "mobile_list":{
                                    "mobile_co":[
                                        {
                                            "mobile_country_code":"086",
                                            "mobile_phone_num":"13876541234"
                                        }
                                    ]
                                },
                                "phone_number_list":{
                                    "phone_co":[
                                        {
                                            "area_code":"0571",
                                            "country_code":"086",
                                            "ext":"1",
                                            "number":"6788876"
                                        }
                                    ]
                                },
                                "position":"经理",
                                "reference_id":"123",
                                "sec_token":"xxx"
                            }
                        ]
                    },
                    "customer_id":"89898989",
                    "customer_phase":"ENQUIRY_GROUP",
                    "fax":{
                        "area_code":"0571",
                        "country_code":"086",
                        "ext":"1",
                        "number":"88888"
                    },
                    "gmt_create":"2020-10-10 00:00:00",
                    "importance_level":"TWO_STAR",
                    "owner_email":"567@123.com",
                    "owner_id_member_seq":"323232",
                    "purchase_category_list":{
                        "string":[
                            "[self_002134]"
                        ]
                    },
                    "remark":"备注",
                    "source_list":{
                        "string":[
                            "[inquiry]"
                        ]
                    },
                    "website":"www.alibaba.com",
                    "alicrm_customer_detail_url":"https:\/\/alicrm.alibaba.com\/#customer-detail?customerId=1234",
                    "in_protecting":false,
                    "growth_level":"L1+"
                }
            ]
        },
        "total":1000
    }
}

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

开放平台

ICBU卖家API

alibaba.seller.customer.batch.get (客户通客户批量查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ