淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
status	Number	必须	0	0:新增，1：修改,-1:删除
type	Number	必须	1	1-ISV系统模板 2-ISV商家模板
template_id	Number	可选	10000	模板id，删除模板时传入
template_params	CardTemplateParamsDto	可选		模板结构，具体看官方文档
template CardTemplateDto 可选卡片短信模版 extend_info CardTemplateExtendInfo 可选模板动参信息 └ params String 可选 [{\"name\":\"${nick}\",\"type\":1,\"example\":\"tb\"}] 动参列表，注意是jsonstring └ purpose String 可选 1 商用:1 试商用:2 └ scene String 可选活动促销场景 template_content CardTemplateContentDto 可选模板内容 pages TmpPageDto [] 可选多页最大10页 tmp_cards TmpCardDto [] 可选页面元素 └ type String 可选资源类型 TEXT └ content String 可选文本内容文本内容 └ src_type Number 可选 1 引入资源类型，1: 资源ID └ src String 可选 1 资源地址 └ cover String 可选 2 视频封面，资源类型为Video 时，为必填 └ action_type String 可选 OPEN_URL action 类型 └ position_number Number 可选 1 位置序号 └ is_text_title Boolean 可选 true 是否为标题 action CardActionDto 可选 action 对象 └ target String 可选 https://s.tb.cn/{#crmShortLink#} 访问地址 └ merchant_name String 可选正在跳转到xxx 访问名称 └ floor_url String 可选 https://s.tb.cn/{#crmShortLink#} OPEN_APP兜底URL └ visible Number 可选 1 某些组件可设置隐藏，0-隐藏，1-可见 └ card_type Number 可选 5 卡片模版类型 └ template_name String 可选测试模板模板名称 └ memo String 可选备注备注

名称	类型	示例值	描述
result	Result	1	result
└ code String 错误码 code └ msg String 错误描述 msg crm_template CrmTemplateDo 1 result └ name String 双十一短信模版 name └ id Number 1 id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmCversionCardtplUpdateRequest req = new OpencrmCversionCardtplUpdateRequest();
req.setStatus(0L);
req.setType(1L);
req.setTemplateId(10000L);
OpencrmCversionCardtplUpdateRequest.CardTemplateParamsDto obj1 = new OpencrmCversionCardtplUpdateRequest.CardTemplateParamsDto();
OpencrmCversionCardtplUpdateRequest.CardTemplateDto obj2 = new OpencrmCversionCardtplUpdateRequest.CardTemplateDto();
OpencrmCversionCardtplUpdateRequest.CardTemplateExtendInfo obj3 = new OpencrmCversionCardtplUpdateRequest.CardTemplateExtendInfo();
obj3.setParams("[{\\"name\\":\\"${nick}\\",\\"type\\":1,\\"example\\":\\"tb\\"}]");
obj3.setPurpose("1");
obj3.setScene("活动促销");
obj2.setExtendInfo(obj3);
OpencrmCversionCardtplUpdateRequest.CardTemplateContentDto obj4 = new OpencrmCversionCardtplUpdateRequest.CardTemplateContentDto();
List<OpencrmCversionCardtplUpdateRequest.TmpPageDto> list6 = new ArrayList<OpencrmCversionCardtplUpdateRequest.TmpPageDto>();
OpencrmCversionCardtplUpdateRequest.TmpPageDto obj7 = new OpencrmCversionCardtplUpdateRequest.TmpPageDto();
list6.add(obj7);
List<OpencrmCversionCardtplUpdateRequest.TmpCardDto> list10 = new ArrayList<OpencrmCversionCardtplUpdateRequest.TmpCardDto>();
OpencrmCversionCardtplUpdateRequest.TmpCardDto obj11 = new OpencrmCversionCardtplUpdateRequest.TmpCardDto();
list10.add(obj11);
obj11.setType("资源类型");
obj11.setContent("文本内容");
obj11.setSrcType(1L);
obj11.setSrc("1");
obj11.setCover("2");
obj11.setActionType("OPEN_URL");
obj11.setPositionNumber(1L);
obj11.setIsTextTitle(true);
OpencrmCversionCardtplUpdateRequest.CardActionDto obj13 = new OpencrmCversionCardtplUpdateRequest.CardActionDto();
obj13.setTarget("https://s.tb.cn/{#crmShortLink#}");
obj13.setMerchantName("正在跳转到xxx");
obj13.setFloorUrl("https://s.tb.cn/{#crmShortLink#}");
list12.setAction(obj13);
obj11.setVisible(1L);
list8.setTmpCards(list10);
obj4.setPages(list6);
obj2.setTemplateContent(obj4);
obj2.setCardType(5L);
obj1.setTemplate(obj2);
obj1.setTemplateName("测试模板");
obj1.setMemo("备注");
req.setTemplateParams(obj1);
OpencrmCversionCardtplUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmCversionCardtplUpdateRequest req = new OpencrmCversionCardtplUpdateRequest();
req.Status = 0L;
req.Type = 1L;
req.TemplateId = 10000L;
OpencrmCversionCardtplUpdateRequest.CardTemplateParamsDtoDomain obj1 = new OpencrmCversionCardtplUpdateRequest.CardTemplateParamsDtoDomain();
OpencrmCversionCardtplUpdateRequest.CardTemplateDtoDomain obj2 = new OpencrmCversionCardtplUpdateRequest.CardTemplateDtoDomain();
OpencrmCversionCardtplUpdateRequest.CardTemplateExtendInfoDomain obj3 = new OpencrmCversionCardtplUpdateRequest.CardTemplateExtendInfoDomain();
obj3.Params = "[{\\"name\\":\\"${nick}\\",\\"type\\":1,\\"example\\":\\"tb\\"}]";
obj3.Purpose = "1";
obj3.Scene = "活动促销";
obj2.ExtendInfo= obj3;
OpencrmCversionCardtplUpdateRequest.CardTemplateContentDtoDomain obj4 = new OpencrmCversionCardtplUpdateRequest.CardTemplateContentDtoDomain();
List<OpencrmCversionCardtplUpdateRequest.TmpPageDtoDomain> list6 = new List<OpencrmCversionCardtplUpdateRequest.TmpPageDtoDomain>();
OpencrmCversionCardtplUpdateRequest.TmpPageDtoDomain obj7 = new OpencrmCversionCardtplUpdateRequest.TmpPageDtoDomain();
list6.Add(obj7);
List<OpencrmCversionCardtplUpdateRequest.TmpCardDtoDomain> list9 = new List<OpencrmCversionCardtplUpdateRequest.TmpCardDtoDomain>();
OpencrmCversionCardtplUpdateRequest.TmpCardDtoDomain obj10 = new OpencrmCversionCardtplUpdateRequest.TmpCardDtoDomain();
list9.Add(obj10);
obj10.Type = "资源类型";
obj10.Content = "文本内容";
obj10.SrcType = 1L;
obj10.Src = "1";
obj10.Cover = "2";
obj10.ActionType = "OPEN_URL";
obj10.PositionNumber = 1L;
obj10.IsTextTitle = true;
OpencrmCversionCardtplUpdateRequest.CardActionDtoDomain obj11 = new OpencrmCversionCardtplUpdateRequest.CardActionDtoDomain();
obj11.Target = "https://s.tb.cn/{#crmShortLink#}";
obj11.MerchantName = "正在跳转到xxx";
obj11.FloorUrl = "https://s.tb.cn/{#crmShortLink#}";
obj10.Action= obj11;
obj10.Visible = 1L;
obj7.TmpCards= list9;
obj4.Pages= list6;
obj2.TemplateContent= obj4;
obj2.CardType = 5L;
obj1.Template= obj2;
obj1.TemplateName = "测试模板";
obj1.Memo = "备注";
req.TemplateParams_ = obj1;
OpencrmCversionCardtplUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmCversionCardtplUpdateRequest;
$req->setStatus("0");
$req->setType("1");
$req->setTemplateId("10000");
$template_params = new CardTemplateParamsDto;
$template = new CardTemplateDto;
$extend_info = new CardTemplateExtendInfo;
$extend_info->params="[{\\"name\\":\\"${nick}\\",\\"type\\":1,\\"example\\":\\"tb\\"}]";
$extend_info->purpose="1";
$extend_info->scene="活动促销";
$template->extend_info = $extend_info;
$template_content = new CardTemplateContentDto;
$pages = new TmpPageDto;
$tmp_cards = new TmpCardDto;
$tmp_cards->type="资源类型";
$tmp_cards->content="文本内容";
$tmp_cards->src_type="1";
$tmp_cards->src="1";
$tmp_cards->cover="2";
$tmp_cards->action_type="OPEN_URL";
$tmp_cards->position_number="1";
$tmp_cards->is_text_title="true";
$action = new CardActionDto;
$action->target="https://s.tb.cn/{#crmShortLink#}";
$action->merchant_name="正在跳转到xxx";
$action->floor_url="https://s.tb.cn/{#crmShortLink#}";
$tmp_cards->action = $action;
$tmp_cards->visible="1";
$pages->tmp_cards = $tmp_cards;
$template_content->pages = $pages;
$template->template_content = $template_content;
$template->card_type="5";
$template_params->template = $template;
$template_params->template_name="测试模板";
$template_params->memo="备注";
$req->setTemplateParams(json_encode($template_params));
$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=taobao.opencrm.cversion.cardtpl.update' \
-d 'partner_id=apidoc' \
-d 'session=a622dd11-a454-4369-bc56-c08647e38a1e' \
-d 'sign=DD421F04D18436AA608CCB808101AB58' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A49%3A52' \
-d 'v=2.0' \
-d 'status=0' \
-d 'template_id=10000' \
-d 'template_params=null' \
-d 'type=1'

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

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

req.status=0
req.type=1
req.template_id=10000
req.template_params=""
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,"taobao.opencrm.cversion.cardtpl.update");
add_param(pRequest,"status","0");
add_param(pRequest,"type","1");
add_param(pRequest,"template_id","10000");
add_param(pRequest,"template_params","数据结构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('taobao.opencrm.cversion.cardtpl.update', {
	'status':'0',
	'type':'1',
	'template_id':'10000',
	'template_params':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_cversion_cardtpl_update_response>
    <result>
        <code>错误码</code>
        <msg>错误描述</msg>
        <crm_template>
            <name>双十一短信模版</name>
            <id>1</id>
        </crm_template>
    </result>
</opencrm_cversion_cardtpl_update_response>

{
    "opencrm_cversion_cardtpl_update_response":{
        "result":{
            "code":"错误码",
            "msg":"错误描述",
            "crm_template":{
                "name":"双十一短信模版",
                "id":1
            }
        }
    }
}

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.cversion.cardtpl.update (卡片短信模板创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ