淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request_list	GeneralMsgTemplateRequest	必须			请求参数列表
└ ext_args String 可选 { "type": 2, "msgType":2 } 拓展参数 └ template_name String 必须测试模版模版名称 └ const_secret_key String 可选 99F07284ED7D3A41D8596BF1BD2EC172 免审构造秘钥 └ const_params String [] 必须 ["{\"itemId\":1111,\"materialCode\":\"item\",\"page\":1,\"position\":1}", "{\"title\":\"测试卡片红包标题\",\"content\":\"测试卡片红包内容\",\"materialCode\":\"text\",\"page\":1,\"position\":2}"] 模版构造参数列表 └ channel String 必须 card_smg 渠道code └ channel_type String 必须 5 渠道下模版类型code

名称	类型	示例值	描述
result	Result	统一返回对象	统一返回对象
└ code String 1001 错误码 └ msg String 未知错误错误描述 result GeneralMsgTemplateVO 1239843 构造结果 └ ext_args String {\"itemUrl\":\"https://h5.m.taobao.com/awp/core/detail.htm?id=694988652671\"} 放置模版构造下一些物料信息的链接 └ construct String [{"materialCode":"item","canBeAlgoRec":true,"page":1,"position":1},{"materialCode":"text","page":1,"position":2}] 系统模版构造 └ channel_const_info String {\"pages\":[{\"tmpCards\":[{\"action\":{\"floorUrl\":\"https://s.tb.cn/cccc\",\"merchantName\":\"正在跳转淘宝APP\",\"packageName\":[\"com.taobao.taobao\"],\"target\":\"tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&module=h5&bootImage=0&afcPromotionOpen=false&source=slk_dp&h5Url=https%3A%2F%2Fs.tb.cn%2F{#mediaSmsUrl#}\"},\"actionType\":\"OPEN_APP\",\"positionNumber\":1,\"src\":\"http://img.alicdn.com/bao/uploaded/i1/cccc.jpg\",\"srcType\":2,\"type\":\"IMAGE\"},{\"content\":\"CRM测试商品请不要拍5\",\"isTextTitle\":true,\"positionNumber\":2,\"type\":\"TEXT\"},{\"content\":\"测试单图文模板1125\",\"isTextTitle\":false,\"positionNumber\":3,\"type\":\"TEXT\"},{\"action\":{\"floorUrl\":\"https://s.tb.cn/cccccc\",\"merchantName\":\"正在跳转淘宝APP\",\"packageName\":[\"com.taobao.taobao\"],\"target\":\"tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&module=h5&bootImage=0&afcPromotionOpen=false&source=slk_dp&h5Url=https%3A%2F%2Fs.tb.cn%2F{#mediaSmsUrl#}\"},\"actionType\":\"OPEN_APP\",\"content\":\"查看详情\",\"positionNumber\":4,\"type\":\"BUTTON\"}]}]} 渠道构造信息，指具体渠道下模版构造信息，示例为卡片短信渠道下的构造信息 └ status Number 2 1:提交审核，2:可使用，3:审核不通过，4:已删除 └ template_id Number 12345 模版id └ template_name String 测试模版模版名称 └ error_msg String 错误信息错误信息 └ channel String card_smg 渠道code └ channel_type String 5 渠道下模版类型code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmSmsSellerTplApplyRequest req = new OpencrmSmsSellerTplApplyRequest();
OpencrmSmsSellerTplApplyRequest.GeneralMsgTemplateRequest obj1 = new OpencrmSmsSellerTplApplyRequest.GeneralMsgTemplateRequest();
obj1.setExtArgs("{         \"type\": 2,         \"msgType\":2       }");
obj1.setTemplateName("测试模版");
obj1.setConstSecretKey("99F07284ED7D3A41D8596BF1BD2EC172");
obj1.setConstParams(""{\"itemId\":1111,\"materialCode\":\"item\",\"page\":1,\"position\":1}", "{\"title\":\"测试卡片红包标题\",\"content\":\"测试卡片红包内容\",\"materialCode\":\"text\",\"page\":1,\"position\":2}"");
obj1.setChannel("card_smg");
obj1.setChannelType("5");
req.setRequestList(obj1);
OpencrmSmsSellerTplApplyResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmSmsSellerTplApplyRequest req = new OpencrmSmsSellerTplApplyRequest();
OpencrmSmsSellerTplApplyRequest.GeneralMsgTemplateRequestDomain obj1 = new OpencrmSmsSellerTplApplyRequest.GeneralMsgTemplateRequestDomain();
obj1.ExtArgs = "{         \"type\": 2,         \"msgType\":2       }";
obj1.TemplateName = "测试模版";
obj1.ConstSecretKey = "99F07284ED7D3A41D8596BF1BD2EC172";
obj1.ConstParams = ""{\"itemId\":1111,\"materialCode\":\"item\",\"page\":1,\"position\":1}", "{\"title\":\"测试卡片红包标题\",\"content\":\"测试卡片红包内容\",\"materialCode\":\"text\",\"page\":1,\"position\":2}"";
obj1.Channel = "card_smg";
obj1.ChannelType = "5";
req.RequestList_ = obj1;
OpencrmSmsSellerTplApplyResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmSmsSellerTplApplyRequest;
$request_list = new GeneralMsgTemplateRequest;
$request_list->ext_args="{         \"type\": 2,         \"msgType\":2       }";
$request_list->template_name="测试模版";
$request_list->const_secret_key="99F07284ED7D3A41D8596BF1BD2EC172";
$request_list->const_params="[\"{\\"itemId\\":1111,\\"materialCode\\":\\"item\\",\\"page\\":1,\\"position\\":1}\", \"{\\"title\\":\\"测试卡片红包标题\\",\\"content\\":\\"测试卡片红包内容\\",\\"materialCode\\":\\"text\\",\\"page\\":1,\\"position\\":2}\"]";
$request_list->channel="card_smg";
$request_list->channel_type="5";
$req->setRequestList(json_encode($request_list));
$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.sms.seller.tpl.apply' \
-d 'partner_id=apidoc' \
-d 'session=a95a95f0-c5b2-4911-af35-0266eb8956e6' \
-d 'sign=1399F295BF55732082D0FFBCC115DEE9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+15%3A52%3A08' \
-d 'v=2.0' \
-d 'request_list=%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%E5%88%97%E8%A1%A8'

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

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

req.request_list="请求参数列表"
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.sms.seller.tpl.apply");
add_param(pRequest,"request_list","数据结构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.sms.seller.tpl.apply', {
	'request_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_sms_seller_tpl_apply_response>
    <result>
        <code>1001</code>
        <msg>未知错误</msg>
        <result>
            <ext_args>{\&quot;itemUrl\&quot;:\&quot;https://h5.m.taobao.com/awp/core/detail.htm?id=694988652671\&quot;}</ext_args>
            <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_const_info>{\&quot;pages\&quot;:[{\&quot;tmpCards\&quot;:[{\&quot;action\&quot;:{\&quot;floorUrl\&quot;:\&quot;https://s.tb.cn/cccc\&quot;,\&quot;merchantName\&quot;:\&quot;正在跳转淘宝APP\&quot;,\&quot;packageName\&quot;:[\&quot;com.taobao.taobao\&quot;],\&quot;target\&quot;:\&quot;tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&amp;module=h5&amp;bootImage=0&amp;afcPromotionOpen=false&amp;source=slk_dp&amp;h5Url=https%3A%2F%2Fs.tb.cn%2F{#mediaSmsUrl#}\&quot;},\&quot;actionType\&quot;:\&quot;OPEN_APP\&quot;,\&quot;positionNumber\&quot;:1,\&quot;src\&quot;:\&quot;http://img.alicdn.com/bao/uploaded/i1/cccc.jpg\&quot;,\&quot;srcType\&quot;:2,\&quot;type\&quot;:\&quot;IMAGE\&quot;},{\&quot;content\&quot;:\&quot;CRM测试商品请不要拍5\&quot;,\&quot;isTextTitle\&quot;:true,\&quot;positionNumber\&quot;:2,\&quot;type\&quot;:\&quot;TEXT\&quot;},{\&quot;content\&quot;:\&quot;测试单图文模板1125\&quot;,\&quot;isTextTitle\&quot;:false,\&quot;positionNumber\&quot;:3,\&quot;type\&quot;:\&quot;TEXT\&quot;},{\&quot;action\&quot;:{\&quot;floorUrl\&quot;:\&quot;https://s.tb.cn/cccccc\&quot;,\&quot;merchantName\&quot;:\&quot;正在跳转淘宝APP\&quot;,\&quot;packageName\&quot;:[\&quot;com.taobao.taobao\&quot;],\&quot;target\&quot;:\&quot;tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&amp;module=h5&amp;bootImage=0&amp;afcPromotionOpen=false&amp;source=slk_dp&amp;h5Url=https%3A%2F%2Fs.tb.cn%2F{#mediaSmsUrl#}\&quot;},\&quot;actionType\&quot;:\&quot;OPEN_APP\&quot;,\&quot;content\&quot;:\&quot;查看详情\&quot;,\&quot;positionNumber\&quot;:4,\&quot;type\&quot;:\&quot;BUTTON\&quot;}]}]}</channel_const_info>
            <status>2</status>
            <template_id>12345</template_id>
            <template_name>测试模版</template_name>
            <error_msg>错误信息</error_msg>
            <channel>card_smg</channel>
            <channel_type>5</channel_type>
        </result>
    </result>
</opencrm_sms_seller_tpl_apply_response>

{
    "opencrm_sms_seller_tpl_apply_response":{
        "result":{
            "code":"1001",
            "msg":"未知错误",
            "result":{
                "ext_args":"{\\\"itemUrl\\\":\\\"https:\/\/h5.m.taobao.com\/awp\/core\/detail.htm?id=694988652671\\\"}",
                "construct":"[{\"materialCode\":\"item\",\"canBeAlgoRec\":true,\"page\":1,\"position\":1},{\"materialCode\":\"text\",\"page\":1,\"position\":2}]",
                "channel_const_info":"{\\\"pages\\\":[{\\\"tmpCards\\\":[{\\\"action\\\":{\\\"floorUrl\\\":\\\"https:\/\/s.tb.cn\/cccc\\\",\\\"merchantName\\\":\\\"正在跳转淘宝APP\\\",\\\"packageName\\\":[\\\"com.taobao.taobao\\\"],\\\"target\\\":\\\"tbopen:\/\/m.taobao.com\/tbopen\/index.html?action=ali.open.nav&module=h5&bootImage=0&afcPromotionOpen=false&source=slk_dp&h5Url=https%3A%2F%2Fs.tb.cn%2F{#mediaSmsUrl#}\\\"},\\\"actionType\\\":\\\"OPEN_APP\\\",\\\"positionNumber\\\":1,\\\"src\\\":\\\"http:\/\/img.alicdn.com\/bao\/uploaded\/i1\/cccc.jpg\\\",\\\"srcType\\\":2,\\\"type\\\":\\\"IMAGE\\\"},{\\\"content\\\":\\\"CRM测试商品请不要拍5\\\",\\\"isTextTitle\\\":true,\\\"positionNumber\\\":2,\\\"type\\\":\\\"TEXT\\\"},{\\\"content\\\":\\\"测试单图文模板1125\\\",\\\"isTextTitle\\\":false,\\\"positionNumber\\\":3,\\\"type\\\":\\\"TEXT\\\"},{\\\"action\\\":{\\\"floorUrl\\\":\\\"https:\/\/s.tb.cn\/cccccc\\\",\\\"merchantName\\\":\\\"正在跳转淘宝APP\\\",\\\"packageName\\\":[\\\"com.taobao.taobao\\\"],\\\"target\\\":\\\"tbopen:\/\/m.taobao.com\/tbopen\/index.html?action=ali.open.nav&module=h5&bootImage=0&afcPromotionOpen=false&source=slk_dp&h5Url=https%3A%2F%2Fs.tb.cn%2F{#mediaSmsUrl#}\\\"},\\\"actionType\\\":\\\"OPEN_APP\\\",\\\"content\\\":\\\"查看详情\\\",\\\"positionNumber\\\":4,\\\"type\\\":\\\"BUTTON\\\"}]}]}",
                "status":2,
                "template_id":12345,
                "template_name":"测试模版",
                "error_msg":"错误信息",
                "channel":"card_smg",
                "channel_type":"5"
            }
        }
    }
}

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.sms.seller.tpl.apply (富媒体短信商家模版申请)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ