调用QuerySmsTemplateList查询短信模板列表详情-短信服务-阿里云

可以通过此接口查询您账号下的所有模板，方便您查看模板详情，包括模板审核状态、模板类型、模板内容等。

接口说明

本接口用于查询您当前账号下所有模板的模板详情。如果您需要查询模板变量内容、申请时上传的文件资料信息等更多内容，可以调用 GetSmsTemplate 接口通过模板 Code 查询单个模板审核详情。
您也可登录短信服务控制台模板管理页查看您当前账号下所有模板的模板详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dysms:QuerySmsTemplateList

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageIndex	integer	否	当前页码。默认取值为 1。	1
PageSize	integer	否	每页显示的模板个数。取值范围：1~50，默认取值为 10。	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	819BE656-D2E0-4858-8B21-B2E47708****
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	状态码的描述。	OK
SmsTemplateList	array<object>	结果列表。
	object	单个模板详情。
TemplateCode	string	短信模板 Code。	SMS_1525***
TemplateName	string	短信模板名称。	验证码模板
OuterTemplateType	integer	模板类型（对外使用）。返回值： 0：验证码短信。 1：通知短信。 2：推广短信。 3：国际/港澳台短信。	0
AuditStatus	string	模板审核状态。返回值： AUDIT_STATE_INIT：审核中。 AUDIT_STATE_PASS：通过审核。 AUDIT_STATE_NOT_PASS：未通过审核，请在返回参数 Reason 中查看审核未通过原因。 AUDIT_SATE_CANCEL：取消审核。	AUDIT_STATE_PASS
TemplateContent	string	模板内容。	验证码为：${code}，您正在注册成为平台会员，感谢您的支持！
CreateDate	string	创建模板的时间，格式为 yyyy-MM-dd HH:mm:ss。	2020-06-04 11:42:17
Reason	object	审核返回值。
RejectDate	string	审核未通过的时间，格式为 yyyy-MM-dd HH:mm:ss。	2020-06-04 16:01:17
RejectInfo	string	审核未通过的原因。	变量不符合规范
RejectSubInfo	string	审核未通过的详细说明。	变量属性选择错误。请根据业务使用场景选择合适的变量属性。
OrderId	string	工单号。审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。	2004983****
TemplateType	integer	模板类型。返回值： 0：短信通知。 1：推广短信。 2：验证码短信。 6：国际/港澳台短信。	2
SignatureName	string	关联签名名称。	阿里云
TotalCount	integer	本次查询到的模板总数。	100
CurrentPage	integer	当前页码。默认取值为 1。	1
PageSize	integer	每页显示的模板个数。取值范围：1~50。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "819BE656-D2E0-4858-8B21-B2E47708****",
  "Code": "OK",
  "Message": "OK",
  "SmsTemplateList": [
    {
      "TemplateCode": "SMS_1525***",
      "TemplateName": "验证码模板",
      "OuterTemplateType": 0,
      "AuditStatus": "AUDIT_STATE_PASS",
      "TemplateContent": "验证码为：${code}，您正在注册成为平台会员，感谢您的支持！",
      "CreateDate": "2020-06-04 11:42:17",
      "Reason": {
        "RejectDate": "2020-06-04 16:01:17",
        "RejectInfo": "变量不符合规范",
        "RejectSubInfo": "变量属性选择错误。\n请根据业务使用场景选择合适的变量属性。"
      },
      "OrderId": "2004983****",
      "TemplateType": 2,
      "SignatureName": "阿里云"
    }
  ],
  "TotalCount": 100,
  "CurrentPage": 1,
  "PageSize": 10
}

错误码

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

变更历史

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