淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
query_str	String	必须	13789898989	查询字符
company_id	String	必须	321312321	商家在零售plus平台上的企业ID
query_str_type	String	可选	phone	可以为空空的话遍历多种ID 也可以 phone cardNo tbNick wxOpenId
query_option	Options	可选		查询参数
└ needPrivileges Boolean 可选 true 默认值：false 是否要会员权益信息 └ needPointsRule Boolean 可选 true 默认值：false 是否要会员积分使用规则

名称	类型	示例值	描述
result	Boolean	true	成功失败
err_code	String	3213	失败码
err_msg	String	无效的参数	失败消息
member_info	MemberInfo		会员名
└ card_no String 02199493992 卡号 └ name String 小A 姓名 └ level_id String 2 级别ID └ level_name String 白金会员级别名 └ gender String 1 会员性别 1：male;0：female └ phone_no String 13789898989 手机号 └ tb_nick String aaxxbb taobaonick └ reg_date String 1988-10-19 10:10:30 注册日期 └ status String 1 状态1可用 └ birth String 1988-10-19 生日 └ points String 1000 可用积分 └ balance String 10000 可用储值余额单位到分 └ wx_open_id String 1231321 微信开放ID └ wx_nick String 小B 微信NICK └ extend_param String json 扩展字段
member_privileges	Privileges []		会员权益
└ name String 生日买一送一权益名 └ type String 1 1折扣 2抵扣 3结构化描述 └ id String 123 权益ID └ amount String 100 如果type为1折扣这里就为小于100的数字（如95折）如type为2 这里的值就为订单减95分（单位到分）如果TYPE为3可以为空 └ desc String 使用说明等使用说明等 └ extend_param String json 扩展字段 support_item_ids SupportItemIds [] 适用的商品ID列表 └ item_id String 1231 适用的商品ID not_support_item_ids NotSupportItemIds [] 不适用的商品ID列表 └ item_id String 32131 不适用的商品ID support_store_ids SupportStoreIds [] 适用门店ID列表 └ store_id String 32131 适用门店ID
points_rule	PointsRule		积分规则
└ points_value String 100 1分钱需要多少积分 └ deduction_limit String 15 百分比，抵扣上限。15代表积分最多能抵扣订单总额的15% └ money_limit String 100 金额上限，单位人民币分 100代表一笔订单最多积分抵扣1元

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaNlifeCrmMemberQueryRequest req = new AlibabaNlifeCrmMemberQueryRequest();
req.setQueryStr("13789898989");
req.setCompanyId("321312321");
req.setQueryStrType("phone");
AlibabaNlifeCrmMemberQueryRequest.Options obj1 = new AlibabaNlifeCrmMemberQueryRequest.Options();
obj1.setNeedPrivileges(true);
obj1.setNeedPointsRule(true);
req.setQueryOption(obj1);
AlibabaNlifeCrmMemberQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaNlifeCrmMemberQueryRequest req = new AlibabaNlifeCrmMemberQueryRequest();
req.QueryStr = "13789898989";
req.CompanyId = "321312321";
req.QueryStrType = "phone";
AlibabaNlifeCrmMemberQueryRequest.OptionsDomain obj1 = new AlibabaNlifeCrmMemberQueryRequest.OptionsDomain();
obj1.NeedPrivileges = true;
obj1.NeedPointsRule = true;
req.QueryOption_ = obj1;
AlibabaNlifeCrmMemberQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaNlifeCrmMemberQueryRequest;
$req->setQueryStr("13789898989");
$req->setCompanyId("321312321");
$req->setQueryStrType("phone");
$query_option = new Options;
$query_option->need_privileges="true";
$query_option->need_points_rule="true";
$req->setQueryOption(json_encode($query_option));
$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=qimen.alibaba.nlife.crm.member.query' \
-d 'partner_id=apidoc' \
-d 'session=988f1bee-5961-415c-b156-e2b34c219a12' \
-d 'sign=2B007B53B722AFEA0A1CEAA9BC889F6B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-13+22%3A23%3A24' \
-d 'v=2.0' \
-d 'company_id=321312321' \
-d 'query_option=1' \
-d 'query_str=13789898989' \
-d 'query_str_type=phone'

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

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

req.query_str="13789898989"
req.company_id="321312321"
req.query_str_type="phone"
req.query_option="1"
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,"qimen.alibaba.nlife.crm.member.query");
add_param(pRequest,"query_str","13789898989");
add_param(pRequest,"company_id","321312321");
add_param(pRequest,"query_str_type","phone");
add_param(pRequest,"query_option","数据结构JSON示例");
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('qimen.alibaba.nlife.crm.member.query', {
	'query_str':'13789898989',
	'company_id':'321312321',
	'query_str_type':'phone',
	'query_option':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<result>true</result>
<err_code>3213</err_code>
<err_msg>无效的参数</err_msg>
<member_info>
    <card_no>02199493992</card_no>
    <name>小A</name>
    <level_id>2</level_id>
    <level_name>白金会员</level_name>
    <gender>1</gender>
    <phone_no>13789898989</phone_no>
    <tb_nick>aaxxbb</tb_nick>
    <reg_date>1988-10-19 10:10:30</reg_date>
    <status>1</status>
    <birth>1988-10-19</birth>
    <points>1000</points>
    <balance>10000</balance>
    <wx_open_id>1231321</wx_open_id>
    <wx_nick>小B</wx_nick>
    <extend_param>json</extend_param>
</member_info>
<member_privileges>
    <privileges>
        <name>生日买一送一</name>
        <type>1</type>
        <id>123</id>
        <amount>100</amount>
        <desc>使用说明等</desc>
        <extend_param>json</extend_param>
        <support_item_ids>
            <support_item_ids>
                <item_id>1231</item_id>
            </support_item_ids>
        </support_item_ids>
        <not_support_item_ids>
            <not_support_item_ids>
                <item_id>32131</item_id>
            </not_support_item_ids>
        </not_support_item_ids>
        <support_store_ids>
            <support_store_ids>
                <store_id>32131</store_id>
            </support_store_ids>
        </support_store_ids>
    </privileges>
</member_privileges>
<points_rule>
    <points_value>100</points_value>
    <deduction_limit>15</deduction_limit>
    <money_limit>100</money_limit>
</points_rule>

{
    "result":true,
    "err_code":"3213",
    "err_msg":"无效的参数",
    "member_info":{
        "card_no":"02199493992",
        "name":"小A",
        "level_id":"2",
        "level_name":"白金会员",
        "gender":"1",
        "phone_no":"13789898989",
        "tb_nick":"aaxxbb",
        "reg_date":"1988-10-19 10:10:30",
        "status":"1",
        "birth":"1988-10-19",
        "points":"1000",
        "balance":"10000",
        "wx_open_id":"1231321",
        "wx_nick":"小B",
        "extend_param":"json"
    },
    "member_privileges":{
        "privileges":[
            {
                "name":"生日买一送一",
                "type":"1",
                "id":"123",
                "amount":"100",
                "desc":"使用说明等",
                "extend_param":"json",
                "support_item_ids":{
                    "support_item_ids":[
                        {
                            "item_id":"1231"
                        }
                    ]
                },
                "not_support_item_ids":{
                    "not_support_item_ids":[
                        {
                            "item_id":"32131"
                        }
                    ]
                },
                "support_store_ids":{
                    "support_store_ids":[
                        {
                            "store_id":"32131"
                        }
                    ]
                }
            }
        ]
    },
    "points_rule":{
        "points_value":"100",
        "deduction_limit":"15",
        "money_limit":"100"
    }
}

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

开放平台

qimen.alibaba.nlife.crm.member.query (会员查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ