阿里大于 -

请求地址：

环境	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_name	String	必须	****模板		模板名称
template_contents	DigitalSmsTemplateContentDto []	必须		最大列表长度：20	系统自动生成
└ file_suffix String 必须 txt 文件后缀名，文字内容转成txt，图片支持gif、jpg、png格式，音频支持mp3格式，视频支持mp4格式，目前只支持上传一个视频文件 └ file_name String 必须 file-1.txt 文件名称，请带上后缀 └ file_size Number 必须 1840901 文件大小，单位：字节 └ file_contents String 必须字符文件二进制数组转base64，转的时候指定编码格式为UTF-8
apply_remark	String	必须	***业务需要		申请说明

名称	类型	示例值	描述
result	Result	0	返回值
└ err_code String 0 错误码 └ success Boolean false true表示成功，false表示失败 └ msg String 成功返回信息描述 └ model String DIGITAL_SMS_***** 模板code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAliqinFcDigitalsmsCreatetemplateRequest req = new AlibabaAliqinFcDigitalsmsCreatetemplateRequest();
req.setTemplateName("****模板");
List<AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDto> list2 = new ArrayList<AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDto>();
AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDto obj3 = new AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDto();
list2.add(obj3);
obj3.setFileSuffix("txt");
obj3.setFileName("file-1.txt");
obj3.setFileSize(1840901L);
obj3.setFileContents("字符");
req.setTemplateContents(list2);
req.setApplyRemark("***业务需要");
AlibabaAliqinFcDigitalsmsCreatetemplateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAliqinFcDigitalsmsCreatetemplateRequest req = new AlibabaAliqinFcDigitalsmsCreatetemplateRequest();
req.TemplateName = "****模板";
List<AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDtoDomain> list2 = new List<AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDtoDomain>();
AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDtoDomain obj3 = new AlibabaAliqinFcDigitalsmsCreatetemplateRequest.DigitalSmsTemplateContentDtoDomain();
list2.Add(obj3);
obj3.FileSuffix = "txt";
obj3.FileName = "file-1.txt";
obj3.FileSize = 1840901L;
obj3.FileContents = "字符";
req.TemplateContents_ = list2;
req.ApplyRemark = "***业务需要";
AlibabaAliqinFcDigitalsmsCreatetemplateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAliqinFcDigitalsmsCreatetemplateRequest;
$req->setTemplateName("****模板");
$template_contents = new DigitalSmsTemplateContentDto;
$template_contents->file_suffix="txt";
$template_contents->file_name="file-1.txt";
$template_contents->file_size="1840901";
$template_contents->file_contents="字符";
$req->setTemplateContents(json_encode($template_contents));
$req->setApplyRemark("***业务需要");
$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=alibaba.aliqin.fc.digitalsms.createtemplate' \
-d 'partner_id=apidoc' \
-d 'session=91296e0a-dd83-463e-8e74-cc38bbf3a8fa' \
-d 'sign=BF223136F0D0BE0C54D89B480BE67897' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-12-04+01%3A00%3A04' \
-d 'v=2.0' \
-d 'apply_remark=***%E4%B8%9A%E5%8A%A1%E9%9C%80%E8%A6%81' \
-d 'template_contents=null' \
-d 'template_name=****%E6%A8%A1%E6%9D%BF'

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

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

req.template_name="****模板"
req.template_contents=""
req.apply_remark="***业务需要"
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,"alibaba.aliqin.fc.digitalsms.createtemplate");
add_param(pRequest,"template_name","****模板");
add_param(pRequest,"template_contents","数据结构JSON示例");
add_param(pRequest,"apply_remark","***业务需要");
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('alibaba.aliqin.fc.digitalsms.createtemplate', {
	'template_name':'****模板',
	'template_contents':'数据结构JSON示例',
	'apply_remark':'***业务需要'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_aliqin_fc_digitalsms_createtemplate_response>
    <result>
        <err_code>0</err_code>
        <success>false</success>
        <msg>成功</msg>
        <model>DIGITAL_SMS_*****</model>
    </result>
</alibaba_aliqin_fc_digitalsms_createtemplate_response>

{
    "alibaba_aliqin_fc_digitalsms_createtemplate_response":{
        "result":{
            "err_code":"0",
            "success":false,
            "msg":"成功",
            "model":"DIGITAL_SMS_*****"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.ERROR_EMPTY_CONTENT	数字短信内容为空	检查template_contents参数是否传参
isv.ERROR_INVALID_FILETYPE	数字短信不支持的文件类型	检查传入的file_suffix文件后缀是否是可支持的，文字内容转成txt，图片支持gif、jpg、png格式，音频支持mp3格式，视频支持mp4格式
isv.ERROR_UPLOAD_OSS	数字短信上传文件失败	数字短信中的内容上传文件服务器有误，请检查文件内容是否太多，或者有误
isv.ERROR_FILE_SIZE_LIMIT	数字短信文件总大小超限	上传的文件内容大小，总共不能超过2M，不包括2M
isv.ERROR_FILE_NAME	数字短信文件名为空	请检查入参中file_name文件名，是否有输入
isv.ERROR_FILE_SUFFIX	数字短信文件后缀为空	请检查入参中file_suffix文件后缀名，是否有输入
isv.ERROR_CREATE_TEMPLATE_ERROR	数字短信模板创建有误	请联系开发人员具体排查

API测试工具错误码查询工具 SDK下载

阿里大于API

alibaba.aliqin.fc.digitalsms.createtemplate (数字短信模板创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ