首页 短信服务 API参考 API目录 模板管理 QuerySmsTemplateList - 查询短信模板列表

QuerySmsTemplateList - 查询短信模板列表

查询短信模板列表详情。

接口说明

可以通过本接口查询短信模板列表详情,包括模板名称、创建时间、模板审核状态等。如果审核未通过,会返回审核失败的原因,请针对具体原因重新修改短信模板。

QPS限制

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

调试

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

调试

授权信息

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

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

请求参数

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

展示第几页的模板信息。默认取值为1

1
PageSizeinteger

每页展示的模板个数。取值范围:1~50

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

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

请求状态码。

OK
Messagestring

状态码的描述。

OK
SmsTemplateListarray

结果列表。

object

结果列表。

TemplateCodestring

短信模板CODE。

您可以登录短信服务控制台,选择国内消息国际/港澳台消息,在模板管理页签中查看模板CODE。也可以通过AddSmsTemplate接口获取模板CODE。

SMS_1525***
TemplateNamestring

模板名称。

阿里云短信测试模板
OuterTemplateTypeinteger

模板类型(推荐对外使用)。取值:

  • 0:验证码短信。
  • 1:通知短信。
  • 2:推广短信。
  • 3:国际/港澳台短信。
  • 7:数字短信。
说明该模板类型与AddSmsTemplate、ModifySmsTemplate 接口的模板类型参数值一致。
0
AuditStatusstring

模板审批状态。取值:

  • AUDIT_STATE_INIT:审核中。
  • AUDIT_STATE_PASS:审核通过。
  • AUDIT_STATE_NOT_PASS:审核未通过,请在返回参数Reason中查看审核未通过原因。
  • AUDIT_STATE_CANCEL:取消审核。
AUDIT_STATE_PASS
TemplateContentstring

模板内容。

123456789
CreateDatestring

短信模板的创建时间,格式为yyyy-MM-dd HH:mm:ss。

2020-06-04 11:42:17
Reasonobject

审核备注。

  • 如果审核状态为审核通过审核中,参数Reason显示为“无审核备注”。
  • 如果审核状态为审核未通过,参数Reason显示审核的具体原因。
RejectDatestring

审批未通过的时间,格式为yyyy-MM-dd HH:mm:ss。

2020-06-04 16:01:17
RejectInfostring

审批未通过的原因。

无审批备注
RejectSubInfostring

审批未通过的备注信息。

无审批备注
OrderIdstring

工单ID。

2361****
TemplateTypeinteger

模板类型。取值:

  • 0:短信通知。
  • 1:推广短信。
  • 2:验证码短信。
  • 6:国际/港澳台短信。
  • 7:数字短信。
7
TotalCountlong

模板总数。

100
CurrentPageinteger

页码。默认取值为1

1
PageSizeinteger

每页展示的模板个数。取值范围: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": "123456789",
      "CreateDate": "2020-06-04 11:42:17",
      "Reason": {
        "RejectDate": "2020-06-04 16:01:17",
        "RejectInfo": "无审批备注",
        "RejectSubInfo": "无审批备注"
      },
      "OrderId": "2361****",
      "TemplateType": 7
    }
  ],
  "TotalCount": 100,
  "CurrentPage": 1,
  "PageSize": 10
}

错误码

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

阿里云首页 短信服务 相关技术圈