淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
domain_id	Number	可选	0	入参domainId
country_code	String	可选	foo	入参countryCode
mobile	String	可选	foo	入参mobile

名称	类型	示例值	描述
result	MpResult		result
└ biz_ext_map String {} 参数bizExtMap └ error_code String foo 参数errorCode └ error_msg String foo 参数errorMsg model User 参数model account UserAccount 参数account └ domain_id Number 0 参数domainId └ email String foo 参数email └ gmt_create Date 2017-01-01 00:00:00 参数gmtCreate └ gmt_havana_active Date 2017-01-01 00:00:00 参数gmtHavanaActive └ gmt_modified Date 2017-01-01 00:00:00 参数gmtModified └ havana_id Number 0 参数havanaId └ id Number 0 参数id └ mobile String foo 参数mobile └ nation_prefix String foo 参数nationPrefix └ nickname String foo 参数nickname └ password String foo 参数password └ user_status Number 0 参数userStatus profile UserProfile 参数profile └ addr_city_id Number 0 参数addrCityId └ addr_province_id Number 0 参数addrProvinceId └ addr_region_id Number 0 参数addrRegionId └ birthday String foo 参数birthday └ education_level Number 0 参数educationLevel └ email String foo 参数email └ gmt_create Date 2017-01-01 00:00:00 参数gmtCreate └ gmt_modified Date 2017-01-01 00:00:00 参数gmtModified └ hobby String foo 参数hobby └ home_city_id Number 0 参数homeCityId └ home_province_id Number 0 参数homeProvinceId └ home_region_id Number 0 参数homeRegionId └ id Number 0 参数id └ identity_card String foo 参数identityCard └ industry Number 0 参数industry └ marriage_status Number 0 参数marriageStatus └ mobile String foo 参数mobile └ month_income Number 0 参数monthIncome └ nation_prefix String foo 参数nationPrefix └ nickname String foo 参数nickname └ phone String foo 参数phone └ real_name String foo 参数realName └ sex Number 0 参数sex user_source UserSource 参数userSource └ account_type Number 0 参数accountType └ business_type Number 0 参数businessType └ customer_kind Number 0 参数customerKind └ device_id String foo 参数deviceId └ device_type Number 0 参数deviceType └ gmt_create Date 2017-01-01 00:00:00 参数gmtCreate └ gmt_modified Date 2017-01-01 00:00:00 参数gmtModified └ marketing_mode Number 0 参数marketingMode └ marketing_platform Number 0 参数marketingPlatform └ marketing_type Number 0 参数marketingType └ nation_id Number 0 参数nationId └ pk_user_id Number 0 参数pkUserId └ refer_url String foo 参数referUrl └ reg_address String foo 参数regAddress └ reg_before_url String foo 参数regBeforeUrl └ reg_city_id Number 0 参数regCityId └ reg_ip String foo 参数regIp └ reg_platform Number 0 参数regPlatform └ system_user_sign Number 0 参数systemUserSign └ terminal_type Number 0 参数terminalType └ success Boolean false 参数success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiMpUcUserprofileGetuserbymobileRequest req = new AlibabaDamaiMpUcUserprofileGetuserbymobileRequest();
req.setDomainId(0L);
req.setCountryCode("foo");
req.setMobile("foo");
AlibabaDamaiMpUcUserprofileGetuserbymobileResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiMpUcUserprofileGetuserbymobileRequest req = new AlibabaDamaiMpUcUserprofileGetuserbymobileRequest();
req.DomainId = 0L;
req.CountryCode = "foo";
req.Mobile = "foo";
AlibabaDamaiMpUcUserprofileGetuserbymobileResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiMpUcUserprofileGetuserbymobileRequest;
$req->setDomainId("0");
$req->setCountryCode("foo");
$req->setMobile("foo");
$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.damai.mp.uc.userprofile.getuserbymobile' \
-d 'partner_id=apidoc' \
-d 'sign=60A496DFCC87805733DDE2611CC5511E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-14+07%3A02%3A24' \
-d 'v=2.0' \
-d 'country_code=foo' \
-d 'domain_id=0' \
-d 'mobile=foo'

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

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

req.domain_id=0
req.country_code="foo"
req.mobile="foo"
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.damai.mp.uc.userprofile.getuserbymobile");
add_param(pRequest,"domain_id","0");
add_param(pRequest,"country_code","foo");
add_param(pRequest,"mobile","foo");
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.damai.mp.uc.userprofile.getuserbymobile', {
	'domain_id':'0',
	'country_code':'foo',
	'mobile':'foo'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_mp_uc_userprofile_getuserbymobile_response>
    <result>
        <biz_ext_map>{}</biz_ext_map>
        <error_code>foo</error_code>
        <error_msg>foo</error_msg>
        <model>
            <account>
                <domain_id>0</domain_id>
                <email>foo</email>
                <gmt_create>2017-01-01 00:00:00</gmt_create>
                <gmt_havana_active>2017-01-01 00:00:00</gmt_havana_active>
                <gmt_modified>2017-01-01 00:00:00</gmt_modified>
                <havana_id>0</havana_id>
                <id>0</id>
                <mobile>foo</mobile>
                <nation_prefix>foo</nation_prefix>
                <nickname>foo</nickname>
                <password>foo</password>
                <user_status>0</user_status>
            </account>
            <profile>
                <addr_city_id>0</addr_city_id>
                <addr_province_id>0</addr_province_id>
                <addr_region_id>0</addr_region_id>
                <birthday>foo</birthday>
                <education_level>0</education_level>
                <email>foo</email>
                <gmt_create>2017-01-01 00:00:00</gmt_create>
                <gmt_modified>2017-01-01 00:00:00</gmt_modified>
                <hobby>foo</hobby>
                <home_city_id>0</home_city_id>
                <home_province_id>0</home_province_id>
                <home_region_id>0</home_region_id>
                <id>0</id>
                <identity_card>foo</identity_card>
                <industry>0</industry>
                <marriage_status>0</marriage_status>
                <mobile>foo</mobile>
                <month_income>0</month_income>
                <nation_prefix>foo</nation_prefix>
                <nickname>foo</nickname>
                <phone>foo</phone>
                <real_name>foo</real_name>
                <sex>0</sex>
            </profile>
            <user_source>
                <account_type>0</account_type>
                <business_type>0</business_type>
                <customer_kind>0</customer_kind>
                <device_id>foo</device_id>
                <device_type>0</device_type>
                <gmt_create>2017-01-01 00:00:00</gmt_create>
                <gmt_modified>2017-01-01 00:00:00</gmt_modified>
                <marketing_mode>0</marketing_mode>
                <marketing_platform>0</marketing_platform>
                <marketing_type>0</marketing_type>
                <nation_id>0</nation_id>
                <pk_user_id>0</pk_user_id>
                <refer_url>foo</refer_url>
                <reg_address>foo</reg_address>
                <reg_before_url>foo</reg_before_url>
                <reg_city_id>0</reg_city_id>
                <reg_ip>foo</reg_ip>
                <reg_platform>0</reg_platform>
                <system_user_sign>0</system_user_sign>
                <terminal_type>0</terminal_type>
            </user_source>
        </model>
        <success>false</success>
    </result>
</alibaba_damai_mp_uc_userprofile_getuserbymobile_response>

{
    "alibaba_damai_mp_uc_userprofile_getuserbymobile_response":{
        "result":{
            "biz_ext_map":"{}",
            "error_code":"foo",
            "error_msg":"foo",
            "model":{
                "account":{
                    "domain_id":0,
                    "email":"foo",
                    "gmt_create":"2017-01-01 00:00:00",
                    "gmt_havana_active":"2017-01-01 00:00:00",
                    "gmt_modified":"2017-01-01 00:00:00",
                    "havana_id":0,
                    "id":0,
                    "mobile":"foo",
                    "nation_prefix":"foo",
                    "nickname":"foo",
                    "password":"foo",
                    "user_status":0
                },
                "profile":{
                    "addr_city_id":0,
                    "addr_province_id":0,
                    "addr_region_id":0,
                    "birthday":"foo",
                    "education_level":0,
                    "email":"foo",
                    "gmt_create":"2017-01-01 00:00:00",
                    "gmt_modified":"2017-01-01 00:00:00",
                    "hobby":"foo",
                    "home_city_id":0,
                    "home_province_id":0,
                    "home_region_id":0,
                    "id":0,
                    "identity_card":"foo",
                    "industry":0,
                    "marriage_status":0,
                    "mobile":"foo",
                    "month_income":0,
                    "nation_prefix":"foo",
                    "nickname":"foo",
                    "phone":"foo",
                    "real_name":"foo",
                    "sex":0
                },
                "user_source":{
                    "account_type":0,
                    "business_type":0,
                    "customer_kind":0,
                    "device_id":"foo",
                    "device_type":0,
                    "gmt_create":"2017-01-01 00:00:00",
                    "gmt_modified":"2017-01-01 00:00:00",
                    "marketing_mode":0,
                    "marketing_platform":0,
                    "marketing_type":0,
                    "nation_id":0,
                    "pk_user_id":0,
                    "refer_url":"foo",
                    "reg_address":"foo",
                    "reg_before_url":"foo",
                    "reg_city_id":0,
                    "reg_ip":"foo",
                    "reg_platform":0,
                    "system_user_sign":0,
                    "terminal_type":0
                }
            },
            "success":false
        }
    }
}

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.damai.mp.uc.userprofile.getuserbymobile (用户信息profile服务getUserByMobile)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ