淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
template_id	Number	可选	001		模版id
page_size	Number	可选	10	默认值：10	页大小
cur_page	Number	可选	1	默认值：1	页号

名称	类型	示例值	描述
result	Result	统一返回对象	统一返回对象
└ total Number 1 total template_list TemplateDto [] 1 result └ gmt_modified Date 1533717837908 修改时间 └ gmt_create Date 1533717837908 创建时间 └ error_msg String 请勿使用纯链接或纯变量审核失败原因 └ status Number 0 审核状态:0-成功，1-失败，2-待审核，3- 删除，4、5-审核中 └ content String 你好:${淘宝昵称}，店铺短链:${店铺短链}。内容 └ name String 客户列表短信模板模版名称 └ id Number 1 模版id └ code String 1001 错误码 └ current_page Number 1 currentPage └ msg String 未知错误错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmTemplateQueryRequest req = new OpencrmTemplateQueryRequest();
req.setTemplateId(001L);
req.setPageSize(10L);
req.setCurPage(1L);
OpencrmTemplateQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmTemplateQueryRequest req = new OpencrmTemplateQueryRequest();
req.TemplateId = 001L;
req.PageSize = 10L;
req.CurPage = 1L;
OpencrmTemplateQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmTemplateQueryRequest;
$req->setTemplateId("001");
$req->setPageSize("10");
$req->setCurPage("1");
$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.template.query' \
-d 'partner_id=apidoc' \
-d 'session=3cd95a28-da29-420f-8467-c2cad5f09539' \
-d 'sign=8B3FAC07344F20E93A1123278BDEBC2A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-18+00%3A17%3A21' \
-d 'v=2.0' \
-d 'cur_page=1' \
-d 'page_size=10' \
-d 'template_id=001'

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

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

req.template_id=001
req.page_size=10
req.cur_page=1
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.template.query");
add_param(pRequest,"template_id","001");
add_param(pRequest,"page_size","10");
add_param(pRequest,"cur_page","1");
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.template.query', {
	'template_id':'001',
	'page_size':'10',
	'cur_page':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_template_query_response>
    <result>
        <total>1</total>
        <template_list>
            <template_dto>
                <gmt_modified>1533717837908</gmt_modified>
                <gmt_create>1533717837908</gmt_create>
                <error_msg>请勿使用纯链接或纯变量</error_msg>
                <status>0</status>
                <content>你好:${淘宝昵称}， 店铺短链:${店铺短链}。</content>
                <name>客户列表短信模板</name>
                <id>1</id>
            </template_dto>
        </template_list>
        <code>1001</code>
        <current_page>1</current_page>
        <msg>未知错误</msg>
    </result>
</opencrm_template_query_response>

{
    "opencrm_template_query_response":{
        "result":{
            "total":1,
            "template_list":{
                "template_dto":[
                    {
                        "gmt_modified":"1533717837908",
                        "gmt_create":"1533717837908",
                        "error_msg":"请勿使用纯链接或纯变量",
                        "status":0,
                        "content":"你好:${淘宝昵称}， 店铺短链:${店铺短链}。",
                        "name":"客户列表短信模板",
                        "id":1
                    }
                ]
            },
            "code":"1001",
            "current_page":1,
            "msg":"未知错误"
        }
    }
}

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.template.query (短信模版查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ