GetSmsTemplateList - 查询模板列表-短信服务(SMS)-阿里云帮助中心

查询模板列表详情（新接口）

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SignName	string	否	签名名称	示例签名
TemplateType	integer	否	模板类型枚举值： 0 : 通知 1 : 推广 2 : 验证码	0
AuditStatus	integer	否	模板审核状态枚举值： 0 : 审批中 1 : 通过 2 : 不通过	1
UsableStateList	array	否	模板状态
	string	否	模板状态枚举值： AVAILABLE : 可用 MISSING_SIGNATURE : 缺少签名 MISSING_TRAFFIC_DRIVING : 缺少引流 MISSING_TRAFFIC_DRIVING_ARCHIVE : 缺少引流材料 UNAVAILABLE : 不可用 MISSING_VARIABLE : 缺少变量	MISSING_SIGNATURE
TemplateName	string	否	模板名称	模板名称
TemplateTag	string	否	模板标签	[{"TagKey":"test2","TagValue":"测试修改,test22"},{"TagKey":"book","TagValue":"sanguo"}]
TemplateCode	string	否	模板 code	SMS_1688168
PageIndex	integer	否	页码, 默认 1	1
PageSize	integer	否	每页数量，默认 10	10

返回参数

名称	类型	描述	示例值
	object
AccessDeniedDetail	string	访问被拒绝详细信息，只有 RAM 校验失败才会返回此字段。	None
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	示例值
Message	string	错误信息，仅错误时返回错误信息。	示例值示例值
Data	object	返回数据。
PageSize	integer	每页数据条数。	78
Total	integer	总条数。	64
PageNo	integer	当前页码。	97
List	array<object>	满足过滤条件的数据列表。
	array<object>	单个模板详情
TemplateCode	string	模板 code	示例值示例值示例值
GmtCreate	string	创建时间	示例值
AuditStatus	integer	模板审核状态	88
TemplateTag	array<object>	模板标签
	object	标签
TagKey	string	标签键。	示例值
TagValue	string	标签值。	示例值示例值
WorkOrderId	string	工单号	示例值示例值
UsableStateList	array	模板可用状态列表
	string	模板可用状态	MISSING_SIGNATURE
TemplateContent	string	模板内容	示例值示例值示例值
TemplateName	string	模板名称	示例值
TemplateType	integer	模板类型	43
SignName	string	签名	示例值示例值
Code	string	请求状态码。取值： OK：代表请求成功。其他错误码，请参见本章节的错误码列表或产品 API 错误码。	示例值示例值
Success	boolean	接口调用是否成功。取值： true：调用成功。 false：调用失败。	true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "示例值",
  "Message": "示例值示例值",
  "Data": {
    "PageSize": 78,
    "Total": 64,
    "PageNo": 97,
    "List": [
      {
        "TemplateCode": "示例值示例值示例值",
        "GmtCreate": "示例值",
        "AuditStatus": 88,
        "TemplateTag": [
          {
            "TagKey": "示例值",
            "TagValue": "示例值示例值"
          }
        ],
        "WorkOrderId": "示例值示例值",
        "UsableStateList": [
          "MISSING_SIGNATURE\n"
        ],
        "TemplateContent": "示例值示例值示例值",
        "TemplateName": "示例值",
        "TemplateType": 43,
        "SignName": "示例值示例值"
      }
    ]
  },
  "Code": "示例值示例值",
  "Success": true
}

错误码

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

变更历史

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