淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
sign_name	String	必须	Test	短信签名（如果是通过OAID发送短信则签名需要是数组格式，数组长度需要和OAID数量保持一致。）
url	String	可选	https://s.tb.cn/Y9.X8sU	废弃字段
sms_template_code	String	必须	SMS_1911	短信模版Code（明文发送短信和OAID发送均不要传数组格式）
rec_num	String	可选	["1234567890"]	短信接收号码，json格式，最多200个号码
sms_content	String	可选	"[{\"msg\":\"hello1\",\"date\":\"2021-12-03\"},{\"msg\":\"hello2\",\"date\":\"2021-12-04\"},{\"msg\":\"hello3\",\"date\":\"2021-12-05\"}]"	模板参数替换方式："[{\"msg\":\"hello1\",\"date\":\"2021-12-03\"},{\"msg\":\"hello2\",\"date\":\"2021-12-04\"},{\"msg\":\"hello3\",\"date\":\"2021-12-05\"}]"
extend_num	String	可选	["123"]	短信扩展码（JSON字符串数组格式），拓展码个数需要和电话号码个数一致。
task_code	String	可选	123456789	废弃字段
task_sign	String	可选	qdsdrefdfacxd	对于taskSign相同的请求平台认为是商家的同一次短信发送，可用于对OAID的明文号码去重。
oaids	String	可选	["adsd","qewee","efdsa"]	OAID批量发短信的入参，传该参数的时候rec_num不需要传，最大50个。
order_ids	String	可选	["123","234","567"]	OAID批量发短信时必传，为OAID一一对应的订单ID。
extra_data	String	可选	{"key":"value"}	如果传，必须是一个JSON对象格式的字符串。

名称	类型	示例值	描述
module	String	427305502400332284^0	短信回执码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
JstSmsMessageDirectBatchsendRequest req = new JstSmsMessageDirectBatchsendRequest();
req.setSignName("Test");
req.setUrl("https://s.tb.cn/Y9.X8sU");
req.setSmsTemplateCode("SMS_1911");
req.setRecNum("[\"1234567890\"]");
req.setSmsContent("\"[{\\"msg\\":\\"hello1\\",\\"date\\":\\"2021-12-03\\"},{\\"msg\\":\\"hello2\\",\\"date\\":\\"2021-12-04\\"},{\\"msg\\":\\"hello3\\",\\"date\\":\\"2021-12-05\\"}]\"");
req.setExtendNum("[\"123\"]");
req.setTaskCode("123456789");
req.setTaskSign("qdsdrefdfacxd");
req.setOaids("[\"adsd\",\"qewee\",\"efdsa\"]");
req.setOrderIds("[\"123\",\"234\",\"567\"]");
req.setExtraData("{\"key\":\"value\"}");
JstSmsMessageDirectBatchsendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
JstSmsMessageDirectBatchsendRequest req = new JstSmsMessageDirectBatchsendRequest();
req.SignName = "Test";
req.Url = "https://s.tb.cn/Y9.X8sU";
req.SmsTemplateCode = "SMS_1911";
req.RecNum = "[\"1234567890\"]";
req.SmsContent = "\"[{\\"msg\\":\\"hello1\\",\\"date\\":\\"2021-12-03\\"},{\\"msg\\":\\"hello2\\",\\"date\\":\\"2021-12-04\\"},{\\"msg\\":\\"hello3\\",\\"date\\":\\"2021-12-05\\"}]\"";
req.ExtendNum = "[\"123\"]";
req.TaskCode = "123456789";
req.TaskSign = "qdsdrefdfacxd";
req.Oaids = "[\"adsd\",\"qewee\",\"efdsa\"]";
req.OrderIds = "[\"123\",\"234\",\"567\"]";
req.ExtraData = "{\"key\":\"value\"}";
JstSmsMessageDirectBatchsendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new JstSmsMessageDirectBatchsendRequest;
$req->setSignName("Test");
$req->setUrl("https://s.tb.cn/Y9.X8sU");
$req->setSmsTemplateCode("SMS_1911");
$req->setRecNum("[\"1234567890\"]");
$req->setSmsContent("\"[{\\"msg\\":\\"hello1\\",\\"date\\":\\"2021-12-03\\"},{\\"msg\\":\\"hello2\\",\\"date\\":\\"2021-12-04\\"},{\\"msg\\":\\"hello3\\",\\"date\\":\\"2021-12-05\\"}]\"");
$req->setExtendNum("[\"123\"]");
$req->setTaskCode("123456789");
$req->setTaskSign("qdsdrefdfacxd");
$req->setOaids("[\"adsd\",\"qewee\",\"efdsa\"]");
$req->setOrderIds("[\"123\",\"234\",\"567\"]");
$req->setExtraData("{\"key\":\"value\"}");
$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.jst.sms.message.direct.batchsend' \
-d 'partner_id=apidoc' \
-d 'session=0fc85638-8b74-48d2-be9e-7bab2a95db27' \
-d 'sign=58304A4BD46C1464FAABA38D6D84BB80' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+21%3A21%3A16' \
-d 'v=2.0' \
-d 'extend_num=%22123%22' \
-d 'extra_data=%7B%5C%22key%5C%22%3A%5C%22value%5C%22%7D' \
-d 'oaids=%22adsd%22%2C%22qewee%22%2C%22efdsa%22' \
-d 'order_ids=%22123%22%2C%22234%22%2C%22567%22' \
-d 'rec_num=%221234567890%22' \
-d 'sign_name=Test' \
-d 'sms_content=%5C%22%5B%7B%5C%5C%22msg%5C%5C%22%3A%5C%5C%22hello1%5C%5C%22%2C%5C%5C%22date%5C%5C%22%3A%5C%5C%222021-12-03%5C%5C%22%7D%2C%7B%5C%5C%22msg%5C%5C%22%3A%5C%5C%22hello2%5C%5C%22%2C%5C%5C%22date%5C%5C%22%3A%5C%5C%222021-12-04%5C%5C%22%7D%2C%7B%5C%5C%22msg%5C%5C%22%3A%5C%5C%22hello3%5C%5C%22%2C%5C%5C%22date%5C%5C%22%3A%5C%5C%222021-12-05%5C%5C%22%7D%5D%5C%22' \
-d 'sms_template_code=SMS_1911' \
-d 'task_code=123456789' \
-d 'task_sign=qdsdrefdfacxd' \
-d 'url=https%3A%2F%2Fs.tb.cn%2FY9.X8sU'

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

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

req.sign_name="Test"
req.url="https://s.tb.cn/Y9.X8sU"
req.sms_template_code="SMS_1911"
req.rec_num="[\"1234567890\"]"
req.sms_content="\"[{\\"msg\\":\\"hello1\\",\\"date\\":\\"2021-12-03\\"},{\\"msg\\":\\"hello2\\",\\"date\\":\\"2021-12-04\\"},{\\"msg\\":\\"hello3\\",\\"date\\":\\"2021-12-05\\"}]\""
req.extend_num="[\"123\"]"
req.task_code="123456789"
req.task_sign="qdsdrefdfacxd"
req.oaids="[\"adsd\",\"qewee\",\"efdsa\"]"
req.order_ids="[\"123\",\"234\",\"567\"]"
req.extra_data="{\"key\":\"value\"}"
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.jst.sms.message.direct.batchsend");
add_param(pRequest,"sign_name","Test");
add_param(pRequest,"url","https://s.tb.cn/Y9.X8sU");
add_param(pRequest,"sms_template_code","SMS_1911");
add_param(pRequest,"rec_num",""1234567890"");
add_param(pRequest,"sms_content","\"[{\\"msg\\":\\"hello1\\",\\"date\\":\\"2021-12-03\\"},{\\"msg\\":\\"hello2\\",\\"date\\":\\"2021-12-04\\"},{\\"msg\\":\\"hello3\\",\\"date\\":\\"2021-12-05\\"}]\"");
add_param(pRequest,"extend_num",""123"");
add_param(pRequest,"task_code","123456789");
add_param(pRequest,"task_sign","qdsdrefdfacxd");
add_param(pRequest,"oaids",""adsd","qewee","efdsa"");
add_param(pRequest,"order_ids",""123","234","567"");
add_param(pRequest,"extra_data","{\"key\":\"value\"}");
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.jst.sms.message.direct.batchsend', {
	'sign_name':'Test',
	'url':'https://s.tb.cn/Y9.X8sU',
	'sms_template_code':'SMS_1911',
	'rec_num':'"1234567890"',
	'sms_content':'\"[{\\"msg\\":\\"hello1\\",\\"date\\":\\"2021-12-03\\"},{\\"msg\\":\\"hello2\\",\\"date\\":\\"2021-12-04\\"},{\\"msg\\":\\"hello3\\",\\"date\\":\\"2021-12-05\\"}]\"',
	'extend_num':'"123"',
	'task_code':'123456789',
	'task_sign':'qdsdrefdfacxd',
	'oaids':'"adsd","qewee","efdsa"',
	'order_ids':'"123","234","567"',
	'extra_data':'{\"key\":\"value\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<jst_sms_message_direct_batchsend_response>
    <module>427305502400332284^0</module>
</jst_sms_message_direct_batchsend_response>

{
    "jst_sms_message_direct_batchsend_response":{
        "module":"427305502400332284^0"
    }
}

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.jst.sms.message.direct.batchsend (OAID批量发送，支持明文手机号发送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ