淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
biz_type	Number	必须	0	规则类型0：积分，1：等级升级，2：等级降级
grade_code	Number	可选	1	等级编码
rule_desc	String	可选	满足消费金额送积分	规则描述
rule_name	String	必须	消费金额送积分	规则名称
rule_text	String	必须	points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;	规则文本
total_flag	Boolean	必须	false	是否为总规则
rule_type	Number	可选	0	0: 忠诚度规则 1: 事件规则 2: 匹配规则

名称	类型	示例值	描述
result	Number	1111	规则ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmRuleAddRequest req = new OpencrmRuleAddRequest();
req.setBizType(0L);
req.setGradeCode(1L);
req.setRuleDesc("满足消费金额送积分");
req.setRuleName("消费金额送积分");
req.setRuleText("points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;");
req.setTotalFlag(false);
req.setRuleType(0L);
OpencrmRuleAddResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmRuleAddRequest req = new OpencrmRuleAddRequest();
req.BizType = 0L;
req.GradeCode = 1L;
req.RuleDesc = "满足消费金额送积分";
req.RuleName = "消费金额送积分";
req.RuleText = "points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;";
req.TotalFlag = false;
req.RuleType = 0L;
OpencrmRuleAddResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmRuleAddRequest;
$req->setBizType("0");
$req->setGradeCode("1");
$req->setRuleDesc("满足消费金额送积分");
$req->setRuleName("消费金额送积分");
$req->setRuleText("points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;");
$req->setTotalFlag("false");
$req->setRuleType("0");
$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.add' \
-d 'partner_id=apidoc' \
-d 'sign=9B38DBFE7A17E15210328C4CB0522E93' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A26%3A03' \
-d 'v=2.0' \
-d 'biz_type=0' \
-d 'grade_code=1' \
-d 'rule_desc=%E6%BB%A1%E8%B6%B3%E6%B6%88%E8%B4%B9%E9%87%91%E9%A2%9D%E9%80%81%E7%A7%AF%E5%88%86' \
-d 'rule_name=%E6%B6%88%E8%B4%B9%E9%87%91%E9%A2%9D%E9%80%81%E7%A7%AF%E5%88%86' \
-d 'rule_text=points%3DinputValue%3Bif%28tradeAmount+%3E0%29+return+tradeAmount%3B+else+return+points%3B' \
-d 'rule_type=0' \
-d 'total_flag=false'

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

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

req.biz_type=0
req.grade_code=1
req.rule_desc="满足消费金额送积分"
req.rule_name="消费金额送积分"
req.rule_text="points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;"
req.total_flag=false
req.rule_type=0
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.add");
add_param(pRequest,"biz_type","0");
add_param(pRequest,"grade_code","1");
add_param(pRequest,"rule_desc","满足消费金额送积分");
add_param(pRequest,"rule_name","消费金额送积分");
add_param(pRequest,"rule_text","points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;");
add_param(pRequest,"total_flag","false");
add_param(pRequest,"rule_type","0");
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.add', {
	'biz_type':'0',
	'grade_code':'1',
	'rule_desc':'满足消费金额送积分',
	'rule_name':'消费金额送积分',
	'rule_text':'points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;',
	'total_flag':'false',
	'rule_type':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_rule_add_response>
    <result>1111</result>
</opencrm_rule_add_response>

{
    "opencrm_rule_add_response":{
        "result":1111
    }
}

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.add (创建规则)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ