调用AddSmsTemplate接口申请短信模板。

使用说明

您可以通过AddSmsTemplate接口或短信服务控制台申请短信模板,模板需要符合短信模板规范。您可以通过QuerySmsTemplate接口或控制台查询模板审核状态和结果。

更多短信模板审核信息,请参见使用须知

QPS限制

本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

说明
  • 审核中的短信模板支持撤回。
  • 短信模板如果审核通过,则不允许修改,只能删除。
  • 通过API接口申请短信模板,一个自然日最多可以提交100次短信模板申请。建议每次申请至少间隔30秒。通过控制台申请短信模板,提交次数无限制。
  • 国内短信模板与国际/港澳台短信模板不通用,请根据实际业务情况分别添加、使用。
  • 填写签名、模板申请信息时,请正确选择签名适用场景、模板类型,详细描述已上线业务的使用场景,并提供可以验证这些业务的网站链接、已备案域名地址、应用市场下载链接、公众号或小程序全称等信息。对于登录场景,还需提供测试账号密码。信息完善的申请说明会提高签名、模板的审核效率。
  • 短信签名和短信模板均需审核通过后方可使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddSmsTemplate

系统规定参数。取值:AddSmsTemplate

TemplateType Integer 1

短信类型。取值:

  • 0:验证码。
  • 1:短信通知。
  • 2:推广短信。
  • 3:国际/港澳台消息。
    说明 推广短信和国际/港澳台消息仅支持企业用户。
TemplateName String 阿里云短信测试模板

模板名称,长度为1~30个字符。

TemplateContent String 您正在申请手机注册,验证码为:${code},5分钟内有效!

模板内容,长度为1~500个字符。

Remark String 房产销售

短信模板申请说明,是模板审核的参考信息之一。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码,请参见错误码列表
Message String OK

状态码的描述。

RequestId String F655A8D5-B967-440B-8683-DAD6FF8DE990

请求ID。

TemplateCode String SMS_15255****

短信模板Code。

示例

请求示例

http(s)://dysmsapi.aliyuncs.com/?Action=AddSmsTemplate
&TemplateType=1
&TemplateName=阿里云短信测试模板
&TemplateContent=您正在申请手机注册,验证码为:${code},5分钟内有效!
&Remark=房产销售
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version='1.0' encoding='UTF-8'?>
<AddSmsTemplateResponse>
    <TemplateCode>SMS_1525****</TemplateCode>
    <Message>OK</Message>
    <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>
    <Code>OK</Code>
</AddSmsTemplateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TemplateCode" : "SMS_1525****",
  "Message" : "OK",
  "RequestId" : "F655A8D5-B967-440B-8683-DAD6FF8DE990",
  "Code" : "OK"
}

错误码

访问错误中心查看更多错误码。