淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
verify_code	String	必须	234872	验证码
phone	String	必须	156xxxx4921	手机号
data_set_id	String	必须	shuwei-pre	数据集id

名称	类型	示例值	描述
result	Result		接口返回model
└ trace_id String 1e37a0b415653273295925253e traceId data UserInfoDto 用户信息DTO └ open_id String E948CB6AF08F55D46467B39D6F6DB0B29BC7F4F382087207 用户openId user_result_code UserResultCode 用户结果code └ result_code String KBT000001 结果code └ result_type String SUCCESS 结果类型 └ result_msg String 成功结果描述 └ success Boolean true 是否成功 └ error String demo 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
KoubeiTribeOpenUserQueryRequest req = new KoubeiTribeOpenUserQueryRequest();
req.setVerifyCode("234872");
req.setPhone("156xxxx4921");
req.setDataSetId("shuwei-pre");
KoubeiTribeOpenUserQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
KoubeiTribeOpenUserQueryRequest req = new KoubeiTribeOpenUserQueryRequest();
req.VerifyCode = "234872";
req.Phone = "156xxxx4921";
req.DataSetId = "shuwei-pre";
KoubeiTribeOpenUserQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new KoubeiTribeOpenUserQueryRequest;
$req->setVerifyCode("234872");
$req->setPhone("156xxxx4921");
$req->setDataSetId("shuwei-pre");
$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.koubei.tribe.open.user.query' \
-d 'partner_id=apidoc' \
-d 'sign=71B6F6859BA66C33536350F42D7C193C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A52%3A14' \
-d 'v=2.0' \
-d 'data_set_id=shuwei-pre' \
-d 'phone=156xxxx4921' \
-d 'verify_code=234872'

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

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

req.verify_code="234872"
req.phone="156xxxx4921"
req.data_set_id="shuwei-pre"
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.koubei.tribe.open.user.query");
add_param(pRequest,"verify_code","234872");
add_param(pRequest,"phone","156xxxx4921");
add_param(pRequest,"data_set_id","shuwei-pre");
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.koubei.tribe.open.user.query', {
	'verify_code':'234872',
	'phone':'156xxxx4921',
	'data_set_id':'shuwei-pre'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<koubei_tribe_open_user_query_response>
    <result>
        <trace_id>1e37a0b415653273295925253e</trace_id>
        <data>
            <open_id>E948CB6AF08F55D46467B39D6F6DB0B29BC7F4F382087207</open_id>
            <user_result_code>
                <result_code>KBT000001</result_code>
                <result_type>SUCCESS</result_type>
                <result_msg>成功</result_msg>
            </user_result_code>
        </data>
        <success>true</success>
        <error>demo</error>
    </result>
</koubei_tribe_open_user_query_response>

{
    "koubei_tribe_open_user_query_response":{
        "result":{
            "trace_id":"1e37a0b415653273295925253e",
            "data":{
                "open_id":"E948CB6AF08F55D46467B39D6F6DB0B29BC7F4F382087207",
                "user_result_code":{
                    "result_code":"KBT000001",
                    "result_type":"SUCCESS",
                    "result_msg":"成功"
                }
            },
            "success":true,
            "error":"demo"
        }
    }
}

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.koubei.tribe.open.user.query (获取用户openId)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ