AI 助理
备案控制台
文档
输入文档关键字查找
首页 短信服务 开发参考 API参考 API目录 模板管理 GetSmsTemplate - 查询模板审核详情（新接口）

GetSmsTemplate - 查询模板审核详情（新接口）

更新时间：
产品详情
相关技术圈
我的收藏

申请模板后，通过此接口查询模板审核详情，可查看模板审核状态。

接口说明

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

  • 审核时间：一般情况下，模板提交后，阿里云预计在 2 个小时内审核完成（审核工作时间：周一至周日 9:00~21:00，法定节假日顺延），建议您尽量在 18:00 前提交申请。

  • 如果模板未通过审核，会返回审核失败的原因，请参考短信审核失败的处理建议，调用 ModifySmsTemplate 接口或在模板管理页面修改短信模板。

  • 当前接口是通过模板 Code 查询单个模板的审核详情。 QuerySmsTemplateList 接口可以查询您当前账号下所有模板的模板详情。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
TemplateCodestring是

短信模板 Code。

SMS_20375****

返回参数

名称类型描述示例值
object
RequestIdstring

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

819BE656-D2E0-4858-8B21-B2E47708****
Codestring

请求状态码。

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

状态码的描述。

OK
TemplateNamestring

短信模板名称。

验证码
TemplateCodestring

短信模板 Code。

SMS_20375****
TemplateContentstring

短信模板内容。

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

短信类型。取值：

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

模板审核状态。返回值：

2
RelatedSignNamestring

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

阿里云
TemplateTaginteger

模板标识，标识模板是用户自定义、系统赠送等。取值：

  • 2：用户自定义创建模板。

  • 3：系统赠送模板。

2
OrderIdstring

工单号。

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

2003019****
VariableAttributestring

模板变量规则。

模板变量规则详情，请参见示例文档。

{"code":"characterWithNumber"}
Remarkstring

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

申请验证码模板
CreateDatestring

创建短信模板的时间。

2024-06-03 10:02:34
AuditInfoobject

审核信息。

RejectInfostring

审核未通过的原因。

模板内容中包含错别字。
AuditDatestring

审核时间。

2024-06-03 11:20:34
FileUrlListarray

文件资料信息，兼容 AddSmsSign 接口创建的签名。

FileUrlstring

文件信息。

//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D
MoreDataFileUrlListarray

更多资料信息，补充上传业务证明文件或业务截图文件列表。

MoreDataFileUrlstring

OSS 上的文件信息。

//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D
IntlTypeinteger

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

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

应用场景内容。

http://www.aliyun.com/

示例

正常返回示例

JSON格式

{
  "RequestId": "819BE656-D2E0-4858-8B21-B2E47708****",
  "Code": "OK",
  "Message": "OK",
  "TemplateName": "验证码",
  "TemplateCode": "SMS_20375****",
  "TemplateContent": "您正在申请手机注册，验证码为：${code}，5分钟内有效！",
  "TemplateType": "0",
  "TemplateStatus": "2",
  "RelatedSignName": "阿里云",
  "TemplateTag": 2,
  "OrderId": "2003019****",
  "VariableAttribute": "{\"code\":\"characterWithNumber\"}\n",
  "Remark": "申请验证码模板",
  "CreateDate": "2024-06-03 10:02:34",
  "AuditInfo": {
    "RejectInfo": "模板内容中包含错别字。",
    "AuditDate": "2024-06-03 11:20:34\n"
  },
  "FileUrlList": {
    "FileUrl": [
      "//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D"
    ]
  },
  "MoreDataFileUrlList": {
    "MoreDataFileUrl": [
      "//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D"
    ]
  },
  "IntlType": 0,
  "ApplyScene": "http://www.aliyun.com/\n"
}

错误码

HTTP status code错误码错误信息描述
400ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限，请联系管理员
404TemplateNotFoundThe template does not exist.该账号下找不到对应模板。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇：UpdateSmsTemplate - 修改短信模板（新接口）下一篇：短信发送
文档推荐