短信模板即接收方收到短信的详细内容,包括变量和模板内容。您可以根据业务需要,申请验证码、通知短信或推广短信,模板审核通过后才可以发送短信。
接口说明
-
通过接口申请短信模板,一个自然日最多可以提交 100 次短信模板申请。建议每次申请至少间隔 30 秒。通过控制台申请短信模板,提交次数无限制。
-
通过接口申请的模板信息会同步在短信服务控制台,在控制台对模板的相关操作,请参见短信模板。
-
提交模板申请后,您可以通过 QuerySmsTemplate 接口查询模板审核状态和详情。也可以配置回执消息,通过 TemplateSmsReport 获取模板的审核状态消息。
-
国内短信模板与国际/港澳台短信模板不通用(不能混用),请根据业务使用场景申请模板。
-
仅支持企业认证用户申请推广短信和国际/港澳台消息,个人用户与企业用户权益区别详情请参见使用须知。
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dysms:AddSmsTemplate | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateType | integer | 是 | 0 | |
TemplateName | string | 是 | 模板名称,长度不超过 30 个字符。 | 验证码 |
TemplateContent | string | 是 | 您正在申请手机注册,验证码为:${code},5分钟内有效! | |
Remark | string | 是 | 短信模板申请说明,长度不超过 100 个字符。 模板审核的参考信息,完善申请说明有助于审核人员理解您的业务场景,提高审核效率。填写指导:
| 申请验证码短信 |
返回参数
示例
正常返回示例
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个验证码作为变量 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史