淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rule_id_list	Number []	必须	1,2,3	最大列表长度：20	需要查询的规则id列表

名称	类型	示例值	描述
result	RuleQueryResponseDto	{“ruleId”:12345}	result
rule_d_t_o_list RuleDto [] ruleDTOList └ app_key String 111222 appKey └ biz_type Number 0 bizType └ grade_code Number 1 gradeCode └ rule_desc String 消费金额送积分 ruleDesc └ rule_id Number 1112 ruleId └ rule_name String 消费金额送积分 ruleName └ rule_text String points=inputValue;if(tradeAmount >0) return tradeAmount; else return points; ruleText └ total_flag Boolean true totalFlag └ rule_type Number 0 ruleType

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmRuleQueryRequest req = new OpencrmRuleQueryRequest();
req.setRuleIdList("1,2,3");
OpencrmRuleQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmRuleQueryRequest req = new OpencrmRuleQueryRequest();
req.RuleIdList = "1,2,3";
OpencrmRuleQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmRuleQueryRequest;
$req->setRuleIdList("1,2,3");
$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.opencrm.rule.query' \
-d 'partner_id=apidoc' \
-d 'sign=A713DC4BBFEACFFA31E98F1F5344D42E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A56%3A38' \
-d 'v=2.0' \
-d 'rule_id_list=1%2C2%2C3'

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

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

req.rule_id_list="1,2,3"
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.opencrm.rule.query");
add_param(pRequest,"rule_id_list","1,2,3");
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.opencrm.rule.query', {
	'rule_id_list':'1,2,3'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_rule_query_response>
    <result>
        <rule_d_t_o_list>
            <rule_dto>
                <app_key>111222</app_key>
                <biz_type>0</biz_type>
                <grade_code>1</grade_code>
                <rule_desc>消费金额送积分</rule_desc>
                <rule_id>1112</rule_id>
                <rule_name>消费金额送积分</rule_name>
                <rule_text>points=inputValue;if(tradeAmount &gt;0) return tradeAmount; else return points;</rule_text>
                <total_flag>true</total_flag>
                <rule_type>0</rule_type>
            </rule_dto>
        </rule_d_t_o_list>
    </result>
</opencrm_rule_query_response>

{
    "opencrm_rule_query_response":{
        "result":{
            "rule_d_t_o_list":{
                "rule_dto":[
                    {
                        "app_key":"111222",
                        "biz_type":0,
                        "grade_code":1,
                        "rule_desc":"消费金额送积分",
                        "rule_id":1112,
                        "rule_name":"消费金额送积分",
                        "rule_text":"points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;",
                        "total_flag":true,
                        "rule_type":0
                    }
                ]
            }
        }
    }
}

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.opencrm.rule.query (查询规则)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ