AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 短信服务 开发参考 API参考 API目录 模板管理 CreateSmsTemplate - 申请短信模板（新接口）

CreateSmsTemplate - 申请短信模板（新接口）

更新时间：
产品详情
我的收藏

短信模板即接收方收到短信的详细内容，包括变量和模板内容。您可以根据业务需要，申请验证码、通知短信或推广短信，模板审核通过后才可以发送短信。

接口说明

  • 新接口和原接口变更的公告详情请参见关于短信服务更新签名&模板接口的公告。

  • 通过接口申请短信模板，建议每次申请至少间隔 30 秒。

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

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

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

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dysms:CreateSmsTemplate

none

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
TemplateName

string

是

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

验证码
TemplateContent

string

是

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

模板内容和变量内容必须符合短信模板规范，否则模板会审核失败。您也可以在申请模板页面，查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见 TemplateContent 参数变量规范。

您正在申请手机注册，验证码为：${code}，5分钟内有效！

Remark

string

否

请描述您使用短信的业务场景或提供业务场景的线上链接，并提供短信完整示例（填入变量内容），信息完整有助于提高模板审核通过率。如未按规范进行填写或不填写，可能会影响您模板审核的通过。

申请验证码短信
TemplateType

integer

是

短信类型。取值：

  • 0：验证码。

  • 1：短信通知。

  • 2：推广短信。

  • 3：国际/港澳台消息。

说明

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

0
RelatedSignName

string

否

模板需要关联的签名名称。关联的短信签名必须为审核通过的签名。

重要

  • 当 TemplateType 参数为 0、1、2 时，此参数必填。

  • 关联签名可以提升审核效率，此处关联的签名和短信发送时选择的签名无关。

验证码签名
TemplateRule

string

否

模板变量规则。变量规则的填写，请参见示例文档。

{"code":"characterWithNumber2"}

MoreData

array

否

更多资料，您可以补充上传业务证明文件或业务截图，有助于审核人员了解您的业务详情。如果您申请的短信模板为推广短信（即 TemplateType 为 2），请上传用户授权证明材料，具体说明请参见用户授权证明材料上传规范。

string

否

上传到 OSS 的文件信息。文件上传操作，请参见 OSS 上传文件。

10098689758*****/1234qwe.png
ApplySceneContent

string

否

业务场景。

  • 模板关联的短信签名使用场景如果为“已上线 APP”，ApplySceneContent必须为以http://开头或https://开头的 App 链接。

  • 模板关联的短信签名使用场景如果为“已注册商标名”、“企事业单位名称”，ApplySceneContent必填。

http://www.aliyun.com/

IntlType

integer

否

国际/港澳台模板类型。当 TemplateType 参数为 3 时，国际/港澳台模板需要设置此参数，取值：

  • 0：短信通知。

  • 1：推广短信。

  • 2：验证码。

0
TrafficDriving

string

否

引流信息列表 JSON 字符串。

重要 JSON 格式，传入前请转为字符串。

{ "trafficDrivingType":"引流类型", "trafficDrivingContent":"引流内容", "variableName":"变量名称" }

重要 如果非变量则 variableName 不传。
trafficDrivingType 引流类型枚举值：

  • DOMAIN：域名类型链接。

  • FIXED_PHONE：固定电话。

  • 400_PHONE：400 开头电话。

  • 800_PHONE：800 开头电话。

  • 95_PHONE：95 开头电话。

  • 96_PHONE：96 开头电话。

  • 1_PHONE：1 开头，3~5 位电话。

  • OTHER_PHONE：其他号码。

[{"trafficDrivingType":"DOMAIN","trafficDrivingContent":"aliyun.com"},{"trafficDrivingType":"1_PHONE","trafficDrivingContent":"1**86","variableName":"my1Phone"}]

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次调用请求的 ID。是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

F655A8D5-B967-440B-8683-DAD6FF8DE991
Code

string

请求状态码。取值：

  • OK：代表请求成功。

  • 其他错误码，请参见本章节的错误码列表或产品 API 错误码。

OK
Message

string

状态码的描述。

successful
TemplateName

string

短信模板名称。

验证码模板
TemplateCode

string

短信模板 Code。

提交模板申请后，您可以使用短信模板 Code，通过 GetSmsTemplate 接口查询模板审核详情。也可以配置回执消息，通过 TemplateSmsReport 获取模板的审核状态消息。

SMS_10000****
OrderId

string

工单号。

审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。

2005020****

示例

正常返回示例

JSON格式

{
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE991",
  "Code": "OK",
  "Message": "successful",
  "TemplateName": "验证码模板",
  "TemplateCode": "SMS_10000****",
  "OrderId": "2005020****"
}

错误码

HTTP status code

错误码

错误信息

描述
400 ForbiddenAction Access to the account is denied. Please contact the administrator.
400 AssocSignUnapproved Associated signature must be approved. 关联签名需使用审核通过签名。
400 InvalidTemplateRule.Format The parameter TemplateRule format must be JSON. 模板变量规则必须填入JSON格式的数据。
400 InvalidMoreData Specified parameter MoreData is not valid. 上传的更多资料无效。
400 TemplateVarLimitExceeded The verification code template only supports one variable. 验证码模板仅支持1个变量。
400 InvalidTemplateContent.Format Invalid template content format. 模板内容格式不正确。
400 InvalidTemplateRule The template variable format is non-standard. Please refer to the variable format specifications in the help documentation. 模版变量不符合规范，请查看短信模板规范文档，传入符合要求的模板变量。
400 ServiceNotOpened This product service is not opened. 产品服务未开通
404 MissingTemplateName The template name cannot be empty. 模板名称不能为空。
404 SmsSignatureNotFound The associated SMS signature does not exist. 关联的短信签名不存在。

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

变更历史

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

上一篇：模板管理下一篇：GetSmsTemplate - 查询模板审核详情（新接口）