首页 短信服务 API参考 API目录 模板管理 AddSmsTemplate - 申请短信模板

AddSmsTemplate - 申请短信模板

创建短信模板。

接口说明

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

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

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

    调试

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

    调试

    授权信息

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

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dysms:AddSmsTemplateWrite
    • SMS
      acs:dysms:*:{#accountId}:*

    请求参数

    名称类型必填描述示例值
    TemplateTypeinteger

    短信类型。取值:

    • 0:验证码。
    • 1:短信通知。
    • 2:推广短信。
    • 3:国际/港澳台消息。
    说明推广短信和国际/港澳台消息仅支持企业用户。
    1
    TemplateNamestring

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

    阿里云短信测试模板
    TemplateContentstring

    模板内容,长度不超过500个字符。

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

    短信模板申请说明,是模板审核的参考信息之一。长度不超过100个字符。

    房产销售

    返回参数

    名称类型描述示例值
    object
    Codestring

    请求状态码。

    • 返回OK代表请求成功。
    • 其他错误码,请参见API错误码
    OK
    Messagestring

    状态码的描述。

    OK
    RequestIdstring

    请求ID。

    F655A8D5-B967-440B-8683-DAD6FF8DE990
    TemplateCodestring

    短信模板Code。

    SMS_15255****

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    阿里云首页 短信服务 相关技术圈