文档

UpdateSmsTemplate - 修改短信模板(新接口)

更新时间:

修改未通过审核的模板,修改后请重新提交审核。

接口说明

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

验证码
TemplateCodestring

未通过审核的模板 Code。

SMS_152550****
TemplateContentstring

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

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

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

短信模板申请说明,是模板审核的参考信息之一。

登录场景使用验证码
TemplateTypeinteger

短信类型。取值:

  • 0:验证码。
  • 1:短信通知。
  • 2:推广短信。
  • 3:国际/港澳台消息。
说明 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见使用须知
0
RelatedSignNamestring

模板申请时关联的短信签名。

阿里云
TemplateRulestring

模板变量规则。

变量规则填写请参见示例文档

{"code":"characterWithNumber"}
MoreDataarray

更多资料,补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。非必填,可不设置。

string

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

10098689758****/1234qwe.png
ApplySceneContentstring

应用场景,填写说明如下:

  • 已备案网站,请填写带有 HTTP 或 HTTPS 的工信部备案的网站域名。

  • 已上线 APP,请填写带有 HTTP 或 HTTPS 的应用商店的展示链接,并确保 App 已经上线。

  • 公众号或小程序,请填写公众号或小程序全称,并确保公众号或小程序已上线。

  • 电商平台店铺名,仅适用于企业用户,请填写带有 HTTP 或 HTTPS 的电商铺的展示链接。

http://www.aliyun.com/
IntlTypeinteger

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

  • 0:验证码。
  • 1:短信通知。
  • 2:推广短信。
0

返回参数

名称类型描述示例值
object
RequestIdstring

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

819BE656-D2E0-4858-8B21-B2E477085AAF
Codestring

请求状态码。

  • 返回 OK 代表请求成功。
  • 其他错误码,请参见本章节的错误码列表或产品 API 错误码
OK
Messagestring

状态码的描述。

OK
TemplateNamestring

短信模板名称。

验证码
TemplateCodestring

短信模板 Code。

SMS_152550****
OrderIdstring

工单号。

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

20041271****

示例

正常返回示例

JSON格式

{
  "RequestId": "819BE656-D2E0-4858-8B21-B2E477085AAF",
  "Code": "OK",
  "Message": "OK",
  "TemplateName": "验证码",
  "TemplateCode": "SMS_152550****",
  "OrderId": "20041271****"
}

错误码

HTTP status code错误码错误信息描述
400ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限,请联系管理员
400AssocSignUnapprovedAssociated signature must be approved.关联签名需使用审核通过签名。
400InvalidTemplateRuleThe template variable format is non-standard. Please refer to the variable format specifications in the help documentation.模版变量不符合规范,请查看https://help.aliyun.com/zh/sms/ user-guide/message-template-specifications/
400InvalidTemplateRule.FormatThe parameter TemplateRule format must be JSON.模板变量规则格式必须为json格式。
400InvalidTemplateRule.FormatThe template variable does not conform to the specification, please check the https://help.aliyun.com/zh/sms/user-guide/message-template-specifications/.模版变量不符合规范,请查看https://help.aliyun.com/zh/sms/ user-guide/message-template-specifications/
400InvalidMoreDataSpecified parameter MoreData is not valid.上传的更多资料无效。
400TemplateVarLimitExceededThe verification code template only supports one variable.验证码模板仅支持1个变量。
400InvalidTemplateContent.FormatInvalid template content format.模板内容格式不正确。
400ServiceNotOpenedThis product service is not opened.产品服务未开通
404MissingTemplateNameThe template name cannot be empty.模板名称不能为空。
404SmsSignatureNotFoundThe associated SMS signature does not exist.关联的短信签名不存在。

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