淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
passport	String	必须	14400000001		账号
passport_type	Number	必须	2		账号类型com.taobao.uic.common.constants.youku.enums.PassportType，1:登录邮箱,2:登录手机号,3:优酷昵称,4:土豆昵称,5:自定义域名

名称	类型	示例值	描述
result	ResultDo	result	返回结果
└ err_msg String success 系统自动生成 └ err_trace String success 返回描述信息 module YoukuUserDto module 用户信息 └ bind_mobile String 13666666666 绑定手机 └ bind_region String CN 登录手机区号 └ create_ip String 1.2.3.4 创建IP └ create_time Number 1584586968848 创建时间 └ domain String www 域名 └ login_email String 1@youku.com 登录邮箱 └ login_email_status String Y 登录邮箱状态 └ login_mobile String 13666666666 登录手机 └ login_protected String off 登录保护 └ login_region String CN 登录手机区号 └ modify_time Number 1584586968848 修改时间 └ nickname String 张三昵称 └ reg_source String 20160317PLF000121_youku 用户注册来源requestPid_requestPidName └ reg_type String mobile_pwd 注册来源com.youku.usercenter.biz.user.api.constant.RegisterType：nickname_pwd：只昵称注册方式，email_bindmobile_pwd：邮箱+绑定手机注册方式，email_only_pwd：仅邮箱注册方式，mobile_pwd：手机注册方式，mobile_sms_code：手机验证码自动注册方式，third_party：第三方自动注册方式，ott： OTT注册，mobile_no_pwd：仅用手机注册 └ status String E 状态com.youku.usercenter.biz.user.api.constant.UserStatus，E：正常，"D：禁用，"C：注销" └ status_reason String xx 原因 └ tid String 123 土豆id └ tudou_nickname String 张三土豆昵称 └ user_type String P 用户类型com.youku.usercenter.biz.user.api.constant.UserType，P：个人，C：企业 └ yid String 123 优酷ID └ ytid String 123 ytid └ ret_code String success 返回code └ success Boolean true 调用是否成功 └ success_and_has_value Boolean true 成功且有结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbmpcYoukuuserGetbypassportRequest req = new TbmpcYoukuuserGetbypassportRequest();
req.setPassport("14400000001");
req.setPassportType(2L);
TbmpcYoukuuserGetbypassportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbmpcYoukuuserGetbypassportRequest req = new TbmpcYoukuuserGetbypassportRequest();
req.Passport = "14400000001";
req.PassportType = 2L;
TbmpcYoukuuserGetbypassportResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbmpcYoukuuserGetbypassportRequest;
$req->setPassport("14400000001");
$req->setPassportType("2");
$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=taobao.tbmpc.youkuuser.getbypassport' \
-d 'partner_id=apidoc' \
-d 'sign=37A559DF01233ED70F17E0A09CF22F01' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+17%3A39%3A06' \
-d 'v=2.0' \
-d 'passport=14400000001' \
-d 'passport_type=2'

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

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

req.passport="14400000001"
req.passport_type=2
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,"taobao.tbmpc.youkuuser.getbypassport");
add_param(pRequest,"passport","14400000001");
add_param(pRequest,"passport_type","2");
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('taobao.tbmpc.youkuuser.getbypassport', {
	'passport':'14400000001',
	'passport_type':'2'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbmpc_youkuuser_getbypassport_response>
    <result>
        <err_msg>success</err_msg>
        <err_trace>success</err_trace>
        <module>
            <bind_mobile>13666666666</bind_mobile>
            <bind_region>CN</bind_region>
            <create_ip>1.2.3.4</create_ip>
            <create_time>1584586968848</create_time>
            <domain>www</domain>
            <login_email>1@youku.com</login_email>
            <login_email_status>Y</login_email_status>
            <login_mobile>13666666666</login_mobile>
            <login_protected>off</login_protected>
            <login_region>CN</login_region>
            <modify_time>1584586968848</modify_time>
            <nickname>张三</nickname>
            <reg_source>20160317PLF000121_youku</reg_source>
            <reg_type>mobile_pwd</reg_type>
            <status>E</status>
            <status_reason>xx</status_reason>
            <tid>123</tid>
            <tudou_nickname>张三</tudou_nickname>
            <user_type>P</user_type>
            <yid>123</yid>
            <ytid>123</ytid>
        </module>
        <ret_code>success</ret_code>
        <success>true</success>
        <success_and_has_value>true</success_and_has_value>
    </result>
</tbmpc_youkuuser_getbypassport_response>

{
    "tbmpc_youkuuser_getbypassport_response":{
        "result":{
            "err_msg":"success",
            "err_trace":"success",
            "module":{
                "bind_mobile":"13666666666",
                "bind_region":"CN",
                "create_ip":"1.2.3.4",
                "create_time":1584586968848,
                "domain":"www",
                "login_email":"1@youku.com",
                "login_email_status":"Y",
                "login_mobile":"13666666666",
                "login_protected":"off",
                "login_region":"CN",
                "modify_time":1584586968848,
                "nickname":"张三",
                "reg_source":"20160317PLF000121_youku",
                "reg_type":"mobile_pwd",
                "status":"E",
                "status_reason":"xx",
                "tid":"123",
                "tudou_nickname":"张三",
                "user_type":"P",
                "yid":"123",
                "ytid":"123"
            },
            "ret_code":"success",
            "success":true,
            "success_and_has_value":true
        }
    }
}

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

taobao.tbmpc.youkuuser.getbypassport (根据账号及账号类型获取账号信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ