查询短信模板

功能介绍

该接口用于用户查询已创建的短信模板。

URI

GET /v1/sms/templates

表1 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	偏移量。表示从偏移量开始查询，offset大于等于0。缺省值：1
limit	否	Integer	每页显示的条目数量。缺省值：10
app_name	否	String	应用名称。
start_time	否	String	开始时间。
end_time	否	String	结束时间。
flow_status	否	String	流程状态。枚举值： Adopted：通过 Reviewing：审核中 Reject：拒绝
template_id	否	String	模板ID。
template_name	否	String	模板名称。
template_type	否	String	模板类型。枚举值： PROMOTION_TYPE：营销类 NOTIFY_TYPE：通知类

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
Content-Type	是	String	请求体参数类型，该字段必须设置为：application/json。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
result	Array of SmsTemplateInfo objects	查询结果。
page_info	Page object	分页信息。

表4 SmsTemplateInfo
参数	参数类型	描述
template_id	String	模板ID。最小长度：1 最大长度：50
template_name	String	模板名称。最小长度：1 最大长度：30
create_time	String	创建时间。最小长度：1 最大长度：20
template_type	String	模板类型。最小长度：1 最大长度：20
app_id	String	应用ID。最小长度：1 最大长度：50
app_name	String	应用名称。最小长度：1 最大长度：30
signature_id	String	签名ID。最小长度：1 最大长度：50
template_content	String	模板内容。最小长度：1 最大长度：500
template_desc	String	申请描述。最小长度：1 最大长度：100
has_variable	String	是否有变量。最小长度：1 最大长度：10
flow_status	String	流程状态。最小长度：1 最大长度：20
status	String	模板状态。最小长度：1 最大长度：20
universal_template	Integer	是否是通用模板。最小值：0 最大值：1
urge_status	String	催审状态。最小长度：0 最大长度：20
urge_time	String	催审时间。最小长度：1 最大长度：20
urge_desc	String	催审描述。最小长度：0 最大长度：64
review_desc	String	审批描述。最小长度：0 最大长度：500

表5 Page
参数	参数类型	描述
offset	Integer	偏移量，表示从此偏移量开始查询，offset大于等于0。
limit	Integer	每页显示的条目数量。
total	Integer	总条数。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	结果状态码。最小长度：0 最大长度：32
error_msg	String	结果详情。最小长度：0 最大长度：32

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	结果状态码。最小长度：0 最大长度：32
error_msg	String	结果详情。最小长度：0 最大长度：32

请求示例

查询状态为审核通过的短信模板。

https://koomessage.myhuaweicloud.cn/v1/sms/templates?flow_status=Adopted

响应示例

状态码： 200

查询短信模板响应体。

{
  "result" : [ {
    "status" : "Normal",
    "template_name" : "营销类07模板",
    "template_type" : "PROMOTION_TYPE",
    "template_content" : "华为云内部测试使用。${1} 回T取关",
    "template_id" : "1512***6",
    "signature_id" : "65ba0c56-aa84-4e68-86a7-****62c50707",
    "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af",
    "app_name" : "APP1",
    "create_time" : "2023-08-04 07:53:40",
    "has_variable" : "Yes",
    "flow_status" : "Adopted",
    "universal_template" : null,
    "template_desc" : "",
    "urge_status" : "NO",
    "urge_time" : null,
    "urge_desc" : null,
    "review_desc" : "请审批"
  }, {
    "status" : "Normal",
    "template_name" : "营销类06模板",
    "template_type" : "PROMOTION_TYPE",
    "template_content" : "测试一体化营销套餐006号${1} 回T取关",
    "template_id" : "1512***5",
    "signature_id" : "af98bc62-cc8b-407e-a37a-****726c19d6",
    "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af",
    "app_name" : "APP1",
    "create_time" : "2023-08-04 07:45:08",
    "has_variable" : "Yes",
    "flow_status" : "Adopted",
    "universal_template" : null,
    "template_desc" : "",
    "urge_status" : "NO",
    "urge_time" : null,
    "urge_desc" : null,
    "review_desc" : "请审批"
  } ],
  "page_info" : {
    "offset" : 1,
    "limit" : 2,
    "total" : 148
  }
}