文档

ListTemplates - 获取模板列表

更新时间:

获取模板注册记录列表。

调试

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

授权信息

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

请求语法

GET /api/v2/templates

请求参数

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

模板内容过滤。

七夕
Namestring

模板名称过滤。

召回
PageNumberinteger

分页数,从 1 开始,默认为 1。

1
PageSizeinteger

分页大小,默认为 10。

10
Statusinteger

审核状态过滤。

  • 0 : 审核中。
  • 1 : 审核通过。
  • 2 : 审核不通过。
0
Typeinteger

模板类型过滤。

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

返回参数

名称类型描述示例值
object

成功获取模板列表,可通过控制台或 GetTemplate 获取审核状态。

Dataobject

返回数据。

PageNumberinteger

分页数,从 1 开始,默认为 1。

1
PageSizeinteger

分页大小,默认为 10。

10
Templatesobject []

分页返回的模板列表。

Contentstring

模板内容。

模板内容
CreatedTimestring

创建时间 (UTC+8)。

2020-01-01 12:00:00
Descriptionstring

申请说明。

申请说明
Idstring

模板 ID。

0a54e195-03e2-40bd-869d-b71cb302783e
Namestring

模板名称。

模板召回-20220101
Reasonstring

审核意见。

同意
SignatureIdstring

签名 ID。

5480e3e7-f578-42d2-8ce8-217dec75f2e6
Statusinteger

审核状态。

  • 0 : 审核中。
  • 1 : 审核通过。
  • 2 : 审核不通过。
0
TemplateCodestring

模板 Code。

SMS_123456
Typeinteger

模板类型。

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

更新时间 (UTC+8)。

2020-01-01 12:00:00
TotalCountinteger

全部模板注册记录数量。

10
ErrorCodeinteger

错误码。

0
ErrorMessagestring

错误信息。

OK
RequestIdstring

请求 ID。

f8651828-609d-4de8-ab49-ab781d7fd85a

示例

正常返回示例

JSON格式

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "Templates": [
      {
        "Content": "模板内容",
        "CreatedTime": "2020-01-01 12:00:00",
        "Description": "申请说明",
        "Id": "0a54e195-03e2-40bd-869d-b71cb302783e",
        "Name": "模板召回-20220101",
        "Reason": "同意",
        "SignatureId": "5480e3e7-f578-42d2-8ce8-217dec75f2e6",
        "Status": 0,
        "TemplateCode": "SMS_123456",
        "Type": 1,
        "UpdatedTime": "2020-01-01 12:00:00"
      }
    ],
    "TotalCount": 10
  },
  "ErrorCode": 0,
  "ErrorMessage": "OK",
  "RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-02-21新增 OpenAPI看变更集
2022-02-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-02-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈