AddSmsTemplate_短信服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 根据工信部规定与运营商相关要求,阿里云进行了模板相关 API 的功能改造。为提升您模板的审核效率和审核通过率,请您使用新接口CreateSmsTemplate-申请短信模板

  • 通过接口申请短信模板,一个自然日最多可以提交 100 次短信模板申请。建议每次申请至少间隔 30 秒。通过控制台申请短信模板,提交次数无限制。

  • 通过接口申请的模板信息会同步在短信服务控制台,在控制台对模板的相关操作,请参见短信模板

  • 提交模板申请后,您可以通过 QuerySmsTemplate 接口查询模板审核状态和详情。也可以配置回执消息,通过 TemplateSmsReport 获取模板的审核状态消息。

  • 国内短信模板与国际/港澳台短信模板不通用(不能混用),请根据业务使用场景申请模板。

  • 仅支持企业认证用户申请推广短信和国际/港澳台消息,个人用户与企业用户权益区别详情请参见使用须知

QPS 限制

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

流控信息

请求速率为1000/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dysms:AddSmsTemplate
Create
全部资源
*

请求参数

字段名称字段详情
TemplateTypeinteger<int32>

短信类型。取值:展开详情

示例值:0
TemplateNamestring

模板名称,长度不超过 30 个字符。

示例值:验证码
TemplateContentstring

模板内容,长度不超过 500 个字符。展开详情

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

短信模板申请说明,长度不超过 100 个字符。展开详情

示例值:申请验证码短信

返回参数

字段名称字段详情
Codestring

请求状态码。展开详情

示例值:OK
Messagestring

状态码的描述。

示例值:OK
RequestIdstring

请求 ID。

示例值:F655A8D5-B967-440B-8683-DAD6FF8DE990
TemplateCodestring

短信模板 Code。展开详情

示例值:SMS_46817****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
TemplateParameterCountIllegal
The verification code template only supports 1 verification code as a variable诊断

变更历史

变更时间变更内容概要操作
2025-03-13
新增deprecated
2022-05-27
新增错误码400

相关示例

通过OpenAPI添加短信模板并查询模板详情
2021-10-29