淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
recipient	String	必须	17621660220	接收人
recipient_type	String	必须	1	1-手机号 2-aliuid 3-appuid
template_id	Number	必须	123	模板ID
params	String	必须	{"company":"阿里体育","code":"1234"}	模板参数
subject	String	可选	测试	短信主题/备注信息
alternative_params	String	可选	{"company":"阿里体育","code":"1234"}	降级参数
send_time	String	可选	2017-9-9 12:00:00	定时发送时间，为空表示立即发送
callback_url	String	可选	http://your_receive_url_address	短信状态推送地址

名称	类型	示例值	描述
alisp_code	String	200	返回状态码
alisp_msg	String	已执行	返回值说明
alisp_data	Json		返回数据

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlisportsCommonserviceSmsTemplateSingleSendRequest req = new AlibabaAlisportsCommonserviceSmsTemplateSingleSendRequest();
req.setRecipient("17621660220");
req.setRecipientType("1");
req.setTemplateId(123L);
req.setParams("{\"company\":\"阿里体育\",\"code\":\"1234\"}");
req.setSubject("测试");
req.setAlternativeParams("{\"company\":\"阿里体育\",\"code\":\"1234\"}");
req.setSendTime("2017-9-9 12:00:00");
req.setCallbackUrl("http://your_receive_url_address");
AlibabaAlisportsCommonserviceSmsTemplateSingleSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlisportsCommonserviceSmsTemplateSingleSendRequest req = new AlibabaAlisportsCommonserviceSmsTemplateSingleSendRequest();
req.Recipient = "17621660220";
req.RecipientType = "1";
req.TemplateId = 123L;
req.Params = "{\"company\":\"阿里体育\",\"code\":\"1234\"}";
req.Subject = "测试";
req.AlternativeParams = "{\"company\":\"阿里体育\",\"code\":\"1234\"}";
req.SendTime = "2017-9-9 12:00:00";
req.CallbackUrl = "http://your_receive_url_address";
AlibabaAlisportsCommonserviceSmsTemplateSingleSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlisportsCommonserviceSmsTemplateSingleSendRequest;
$req->setRecipient("17621660220");
$req->setRecipientType("1");
$req->setTemplateId("123");
$req->setParams("{\"company\":\"阿里体育\",\"code\":\"1234\"}");
$req->setSubject("测试");
$req->setAlternativeParams("{\"company\":\"阿里体育\",\"code\":\"1234\"}");
$req->setSendTime("2017-9-9 12:00:00");
$req->setCallbackUrl("http://your_receive_url_address");
$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=alibaba.alisports.commonservice.sms.template.single.send' \
-d 'partner_id=apidoc' \
-d 'sign=3B6D9C7D01E37B8F3C2B5F7D20078A6D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-15+06%3A19%3A33' \
-d 'v=2.0' \
-d 'alternative_params=%7B%5C%22company%5C%22%3A%5C%22%E9%98%BF%E9%87%8C%E4%BD%93%E8%82%B2%5C%22%2C%5C%22code%5C%22%3A%5C%221234%5C%22%7D' \
-d 'callback_url=http%3A%2F%2Fyour_receive_url_address' \
-d 'params=%7B%5C%22company%5C%22%3A%5C%22%E9%98%BF%E9%87%8C%E4%BD%93%E8%82%B2%5C%22%2C%5C%22code%5C%22%3A%5C%221234%5C%22%7D' \
-d 'recipient=17621660220' \
-d 'recipient_type=1' \
-d 'send_time=2017-9-9+12%3A00%3A00' \
-d 'subject=%E6%B5%8B%E8%AF%95' \
-d 'template_id=123'

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

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

req.recipient="17621660220"
req.recipient_type="1"
req.template_id=123
req.params="{\"company\":\"阿里体育\",\"code\":\"1234\"}"
req.subject="测试"
req.alternative_params="{\"company\":\"阿里体育\",\"code\":\"1234\"}"
req.send_time="2017-9-9 12:00:00"
req.callback_url="http://your_receive_url_address"
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,"alibaba.alisports.commonservice.sms.template.single.send");
add_param(pRequest,"recipient","17621660220");
add_param(pRequest,"recipient_type","1");
add_param(pRequest,"template_id","123");
add_param(pRequest,"params","{\"company\":\"阿里体育\",\"code\":\"1234\"}");
add_param(pRequest,"subject","测试");
add_param(pRequest,"alternative_params","{\"company\":\"阿里体育\",\"code\":\"1234\"}");
add_param(pRequest,"send_time","2017-9-9 12:00:00");
add_param(pRequest,"callback_url","http://your_receive_url_address");
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('alibaba.alisports.commonservice.sms.template.single.send', {
	'recipient':'17621660220',
	'recipient_type':'1',
	'template_id':'123',
	'params':'{\"company\":\"阿里体育\",\"code\":\"1234\"}',
	'subject':'测试',
	'alternative_params':'{\"company\":\"阿里体育\",\"code\":\"1234\"}',
	'send_time':'2017-9-9 12:00:00',
	'callback_url':'http://your_receive_url_address'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alisports_commonservice_sms_template_single_send_response>
    <alisp_code>200</alisp_code>
    <alisp_msg>已执行</alisp_msg>
    <alisp_data></alisp_data>
</alibaba_alisports_commonservice_sms_template_single_send_response>

{
    "alibaba_alisports_commonservice_sms_template_single_send_response":{
        "alisp_code":"200",
        "alisp_msg":"已执行",
        "alisp_data":""
    }
}

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

alibaba.alisports.commonservice.sms.template.single.send (模板发送单条短信)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ