淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
task_content	ShortMessageDeliverTaskContent	必须			短息任务参数集合
└ tpl_plh String 可选 content 聚石塔申请的短信模板占位符 └ deliver_targets String [] 必须 ["123456","233445"] ouid列表 └ signature String 必须 jinse01官方旗舰店短信签名 └ tpl_code String 可选 SMS_3385002 聚石塔申请的短信模板Code └ out_node_inst_id Number 必须 100015 节点实例ID（回执信息唯一标志） └ msg_type Number 必须 1 短信类型 └ mobile_acquisition_rule String [] 可选 [3,1,2] 自定义手机号获取规则 └ logistics_order_id_list String [] 可选 ["233425645","233835645"] 指定订单号列表 └ seller_tpl String 可选模板内容直接写“模板内容”即可 └ sms_up_extend_code String 可选 12345 短信拓展码 └ extend_name String 可选 XXX天猫期舰店短信拓展名称 └ digital_template_id String 可选 1113236 数字短信模版id, 选择回落数字短信使用，填写使用富媒体短信模版申请接口和数字短信模版申请接口通过的模版id └ digital_template_list String [] 可选 ["1113236","1112345"] 选择回落数字短信,并且多模版推荐时使用，模版必须为富媒体短信模版申请通过的单图文和单商品数字模版，且模版的占位符必须相同 └ plh_val String 可选 {"nick":"jinse01","point":"10","levelName":"普通会员","shortLink":"c.tb.cn/c.Kgsf"} 卖家设置的模板占位符值

名称	类型	示例值	描述
result	Boolean	false	是否成功生成单点投递任务
result_error_code	String	90001	错误码
result_error_msg	String	系统异常	报错信息
is_successed	Boolean	false	接口是否调用成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmDigitalSmsSingleSendRequest req = new OpencrmDigitalSmsSingleSendRequest();
OpencrmDigitalSmsSingleSendRequest.ShortMessageDeliverTaskContent obj1 = new OpencrmDigitalSmsSingleSendRequest.ShortMessageDeliverTaskContent();
obj1.setTplPlh("content");
obj1.setDeliverTargets(""123456","233445"");
obj1.setSignature("jinse01官方旗舰店");
obj1.setTplCode("SMS_3385002");
obj1.setOutNodeInstId(100015L);
obj1.setMsgType(1L);
obj1.setMobileAcquisitionRule("3,1,2");
obj1.setLogisticsOrderIdList(""233425645","233835645"");
obj1.setSellerTpl("模板内容");
obj1.setSmsUpExtendCode("12345");
obj1.setExtendName("XXX天猫期舰店");
obj1.setDigitalTemplateId("1113236");
obj1.setDigitalTemplateList(""1113236","1112345"");
obj1.setPlhVal("{\"nick\":\"jinse01\",\"point\":\"10\",\"levelName\":\"普通会员\",\"shortLink\":\"c.tb.cn/c.Kgsf\"}");
req.setTaskContent(obj1);
OpencrmDigitalSmsSingleSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmDigitalSmsSingleSendRequest req = new OpencrmDigitalSmsSingleSendRequest();
OpencrmDigitalSmsSingleSendRequest.ShortMessageDeliverTaskContentDomain obj1 = new OpencrmDigitalSmsSingleSendRequest.ShortMessageDeliverTaskContentDomain();
obj1.TplPlh = "content";
obj1.DeliverTargets = ""123456","233445"";
obj1.Signature = "jinse01官方旗舰店";
obj1.TplCode = "SMS_3385002";
obj1.OutNodeInstId = 100015L;
obj1.MsgType = 1L;
obj1.MobileAcquisitionRule = "3,1,2";
obj1.LogisticsOrderIdList = ""233425645","233835645"";
obj1.SellerTpl = "模板内容";
obj1.SmsUpExtendCode = "12345";
obj1.ExtendName = "XXX天猫期舰店";
obj1.DigitalTemplateId = "1113236";
obj1.DigitalTemplateList = ""1113236","1112345"";
obj1.PlhVal = "{\"nick\":\"jinse01\",\"point\":\"10\",\"levelName\":\"普通会员\",\"shortLink\":\"c.tb.cn/c.Kgsf\"}";
req.TaskContent_ = obj1;
OpencrmDigitalSmsSingleSendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmDigitalSmsSingleSendRequest;
$task_content = new ShortMessageDeliverTaskContent;
$task_content->tpl_plh="content";
$task_content->deliver_targets="[\"123456\",\"233445\"]";
$task_content->signature="jinse01官方旗舰店";
$task_content->tpl_code="SMS_3385002";
$task_content->out_node_inst_id="100015";
$task_content->msg_type="1";
$task_content->mobile_acquisition_rule="[3,1,2]";
$task_content->logistics_order_id_list="[\"233425645\",\"233835645\"]";
$task_content->seller_tpl="模板内容";
$task_content->sms_up_extend_code="12345";
$task_content->extend_name="XXX天猫期舰店";
$task_content->digital_template_id="1113236";
$task_content->digital_template_list="[\"1113236\",\"1112345\"]";
$task_content->plh_val="{\"nick\":\"jinse01\",\"point\":\"10\",\"levelName\":\"普通会员\",\"shortLink\":\"c.tb.cn/c.Kgsf\"}";
$req->setTaskContent(json_encode($task_content));
$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.digital.sms.single.send' \
-d 'partner_id=apidoc' \
-d 'session=fe98430e-49fb-45fc-8402-0d839d7e7326' \
-d 'sign=8BD559D6772F1EF743D35971BF396B1B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A33%3A45' \
-d 'v=2.0' \
-d 'task_content=null'

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

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

req.task_content=""
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.digital.sms.single.send");
add_param(pRequest,"task_content","数据结构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.digital.sms.single.send', {
	'task_content':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_digital_sms_single_send_response>
    <result>false</result>
    <result_error_code>90001</result_error_code>
    <result_error_msg>系统异常</result_error_msg>
    <is_successed>false</is_successed>
</opencrm_digital_sms_single_send_response>

{
    "opencrm_digital_sms_single_send_response":{
        "result":false,
        "result_error_code":"90001",
        "result_error_msg":"系统异常",
        "is_successed":false
    }
}

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.digital.sms.single.send (C版用户数字短信单点发送接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ