淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
channel	String	必须	card_smg		渠道code,短信渠道有card_smg卡片短信、digital_smg数字短信、text_smg文本短信
channel_type	String	可选	5		渠道下的模版类型code，例如卡片短信下的单图文模版，不传则获取改渠道下的所有系统模版

名称	类型	示例值	描述
result	Result	统一返回对象	统一返回对象
└ code String 1001 错误码 └ msg String 未知错误错误描述 result GeneralMsgTemplateVO [] 1239843 查询结果 └ channel String card_smg 渠道code └ channel_type String 5 渠道下模版类型code └ construct String [{"materialCode":"item","canBeAlgoRec":true,"page":1,"position":1},{"materialCode":"text","page":1,"position":2}] 模版构造 └ channel_format_rules String 图片：商品16:9主图标题：商品标题，上限17字正文：自定义文本内容，上限69字按钮：按钮标题为查看详情，默认跳转商品详情页，可自定义替换跳转地址，占位符key：mediaSmsUrl 渠道物料内容格式规范，纯文本 └ template_name String 单图文卡片短信模版模版名称 └ channel_const String 1 预留参数，渠道模版构造 └ biz_scene String 1 预留参数，业务场景 └ biz_scene_group String 1 预留参数，业务场景组

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmSystemTemplateGetRequest req = new OpencrmSystemTemplateGetRequest();
req.setChannel("card_smg");
req.setChannelType("5");
OpencrmSystemTemplateGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmSystemTemplateGetRequest req = new OpencrmSystemTemplateGetRequest();
req.Channel = "card_smg";
req.ChannelType = "5";
OpencrmSystemTemplateGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmSystemTemplateGetRequest;
$req->setChannel("card_smg");
$req->setChannelType("5");
$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.system.template.get' \
-d 'partner_id=apidoc' \
-d 'session=543313c4-cbf4-4cfa-8170-6da932433ebc' \
-d 'sign=4879C394489BA4B5F931B3FE8613EE7D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+15%3A52%3A09' \
-d 'v=2.0' \
-d 'channel=card_smg' \
-d 'channel_type=5'

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

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

req.channel="card_smg"
req.channel_type="5"
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.system.template.get");
add_param(pRequest,"channel","card_smg");
add_param(pRequest,"channel_type","5");
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.system.template.get', {
	'channel':'card_smg',
	'channel_type':'5'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_system_template_get_response>
    <result>
        <code>1001</code>
        <msg>未知错误</msg>
        <result>
            <general_msg_template_v_o>
                <channel>card_smg</channel>
                <channel_type>5</channel_type>
                <construct>[{&quot;materialCode&quot;:&quot;item&quot;,&quot;canBeAlgoRec&quot;:true,&quot;page&quot;:1,&quot;position&quot;:1},{&quot;materialCode&quot;:&quot;text&quot;,&quot;page&quot;:1,&quot;position&quot;:2}]</construct>
                <channel_format_rules>图片：商品16:9主图 标题：商品标题，上限17字 正文：自定义文本内容，上限69字 按钮：按钮标题为查看详情，默认跳转商品详情页，可自定义替换跳转地址，占位符key：mediaSmsUrl</channel_format_rules>
                <template_name>单图文卡片短信模版</template_name>
                <channel_const>1</channel_const>
                <biz_scene>1</biz_scene>
                <biz_scene_group>1</biz_scene_group>
            </general_msg_template_v_o>
        </result>
    </result>
</opencrm_system_template_get_response>

{
    "opencrm_system_template_get_response":{
        "result":{
            "code":"1001",
            "msg":"未知错误",
            "result":{
                "general_msg_template_v_o":[
                    {
                        "channel":"card_smg",
                        "channel_type":"5",
                        "construct":"[{\"materialCode\":\"item\",\"canBeAlgoRec\":true,\"page\":1,\"position\":1},{\"materialCode\":\"text\",\"page\":1,\"position\":2}]",
                        "channel_format_rules":"图片：商品16:9主图 标题：商品标题，上限17字 正文：自定义文本内容，上限69字 按钮：按钮标题为查看详情，默认跳转商品详情页，可自定义替换跳转地址，占位符key：mediaSmsUrl",
                        "template_name":"单图文卡片短信模版",
                        "channel_const":"1",
                        "biz_scene":"1",
                        "biz_scene_group":"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.system.template.get (官方模版获取接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ