调用AddSmsTemplate申请短信模板_短信服务(SMS)-阿里云帮助中心

说明

目前该API接口已标记为弃用，推荐使用替代API：Dysmsapi(2017-05-25) - CreateSmsTemplate。

接口说明

根据工信部规定与运营商相关要求，阿里云进行了模板相关 API 的功能改造。为提升您模板的审核效率和审核通过率，请您使用新接口CreateSmsTemplate-申请短信模板。
通过接口申请短信模板，一个自然日最多可以提交 100 次短信模板申请。建议每次申请至少间隔 30 秒。通过控制台申请短信模板，提交次数无限制。
通过接口申请的模板信息会同步在短信服务控制台，在控制台对模板的相关操作，请参见短信模板。
提交模板申请后，您可以通过 QuerySmsTemplate 接口查询模板审核状态和详情。也可以配置回执消息，通过 TemplateSmsReport 获取模板的审核状态消息。
国内短信模板与国际/港澳台短信模板不通用（不能混用），请根据业务使用场景申请模板。
仅支持企业认证用户申请推广短信和国际/港澳台消息，个人用户与企业用户权益区别详情请参见使用须知。

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

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作

访问级别

资源类型

条件关键字

关联操作

dysms:AddSmsTemplate

create

*全部资源

*

无

名称	类型	必填	描述	示例值
TemplateType	integer	是	短信类型。取值： 0：验证码。 1：短信通知。 2：推广短信。 3：国际/港澳台消息。说明仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见使用须知。	0
TemplateName	string	是	模板名称，长度不超过 30 个字符。	验证码
TemplateContent	string	是	模板内容，长度不超过 500 个字符。模板内容和变量内容必须符合短信模板规范，否则模板会审核失败。您也可以在申请模板页面，查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见 TemplateContent 参数变量规范。	您正在申请手机注册，验证码为：${code}，5分钟内有效！
Remark	string	是	短信模板申请说明，长度不超过 100 个字符。模板审核的参考信息，完善申请说明有助于审核人员理解您的业务场景，提高审核效率。填写指导：您可以提供已上线业务的使用场景。您可以提供真实场景的短信示例，体现您的业务场景。您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。登录场景，您可以提供测试账号和密码。	申请验证码短信

名称	类型	描述	示例值
	object
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见 API 错误码。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求 ID。	F655A8D5-B967-440B-8683-DAD6FF8DE990
TemplateCode	string	短信模板 Code。提交模板申请后，您可以使用短信模板 Code，通过 QuerySmsTemplate 接口查询模板审核详情。也可以配置回执消息，通过 TemplateSmsReport 获取模板的审核状态消息。	SMS_46817****

正常返回示例

JSON格式

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

HTTP status code	错误码	错误信息	描述
400	TemplateParameterCountIllegal	The verification code template only supports 1 verification code as a variable	验证码模板仅支持1个验证码作为变量

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

更多信息，参考变更详情。