淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_list	RuleDto []	必须		最大列表长度：20	系统自动生成
└ biz_type Number 必须 0 0 积分,1 等级升级,2:等级降级 └ grade_code Number 可选 1 等级code值，只有在是等级规则必填 └ id 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 是否为总规则

名称	类型	示例值	描述
msg_code	String	0	code
msg_info	String	成功	msg
result	RuleAddResponseDto	<1,1>	result:Map
rule_add_result_d_t_o_list RuleAddResultDto [] ruleAddResultDTOList └ code String 1 code └ id Number 1 id └ msg String 成功 msg └ rule_id Number 1121 ruleId └ is_success Boolean true success
all_success	Boolean	true	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmRuleBatchaddRequest req = new OpencrmRuleBatchaddRequest();
List<OpencrmRuleBatchaddRequest.RuleDto> list2 = new ArrayList<OpencrmRuleBatchaddRequest.RuleDto>();
OpencrmRuleBatchaddRequest.RuleDto obj3 = new OpencrmRuleBatchaddRequest.RuleDto();
list2.add(obj3);
obj3.setBizType(0L);
obj3.setGradeCode(1L);
obj3.setId(1L);
obj3.setRuleDesc("按消费金额送积分");
obj3.setRuleName("消费金额送积分");
obj3.setRuleText("points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;");
obj3.setTotalFlag(false);
req.setParamList(list2);
OpencrmRuleBatchaddResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmRuleBatchaddRequest req = new OpencrmRuleBatchaddRequest();
List<OpencrmRuleBatchaddRequest.RuleDtoDomain> list2 = new List<OpencrmRuleBatchaddRequest.RuleDtoDomain>();
OpencrmRuleBatchaddRequest.RuleDtoDomain obj3 = new OpencrmRuleBatchaddRequest.RuleDtoDomain();
list2.Add(obj3);
obj3.BizType = 0L;
obj3.GradeCode = 1L;
obj3.Id = 1L;
obj3.RuleDesc = "按消费金额送积分";
obj3.RuleName = "消费金额送积分";
obj3.RuleText = "points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;";
obj3.TotalFlag = false;
req.ParamList_ = list2;
OpencrmRuleBatchaddResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmRuleBatchaddRequest;
$param_list = new RuleDto;
$param_list->biz_type="0";
$param_list->grade_code="1";
$param_list->id="1";
$param_list->rule_desc="按消费金额送积分";
$param_list->rule_name="消费金额送积分";
$param_list->rule_text="points=inputValue;if(tradeAmount >0) return tradeAmount; else return points;";
$param_list->total_flag="false";
$req->setParamList(json_encode($param_list));
$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.batchadd' \
-d 'partner_id=apidoc' \
-d 'sign=F3B1C3AC85E3D5B457212235F99DA852' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A15%3A21' \
-d 'v=2.0' \
-d 'param_list=null'

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

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

req.param_list=""
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.batchadd");
add_param(pRequest,"param_list","数据结构JSON示例");
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.batchadd', {
	'param_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_rule_batchadd_response>
    <msg_code>0</msg_code>
    <msg_info>成功</msg_info>
    <result>
        <rule_add_result_d_t_o_list>
            <rule_add_result_dto>
                <code>1</code>
                <id>1</id>
                <msg>成功</msg>
                <rule_id>1121</rule_id>
                <is_success>true</is_success>
            </rule_add_result_dto>
        </rule_add_result_d_t_o_list>
    </result>
    <all_success>true</all_success>
</opencrm_rule_batchadd_response>

{
    "opencrm_rule_batchadd_response":{
        "msg_code":"0",
        "msg_info":"成功",
        "result":{
            "rule_add_result_d_t_o_list":{
                "rule_add_result_dto":[
                    {
                        "code":"1",
                        "id":1,
                        "msg":"成功",
                        "rule_id":1121,
                        "is_success":true
                    }
                ]
            }
        },
        "all_success":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.opencrm.rule.batchadd (批量新增规则)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ