文档首页/ 云消息服务 KooMessage/ API参考/ API/ 短信模板/ 获取短信模板详情
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

获取短信模板详情

功能介绍

该接口用于用户获取已创建的短信模板详情。

URI

GET /v1/sms/templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

template_id

是

String

短信模板ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

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

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

最小长度：0

最大长度：32

error_msg

String

结果详情。

最小长度：0

最大长度：32

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

最小长度：0

最大长度：32

error_msg

String

结果详情。

最小长度：0

最大长度：32

请求示例

获取ID为"1512***3"的短信模板详情。

https://koomessage.myhuaweicloud.cn/v1/sms/templates/1512***3

响应示例

状态码： 200

获取短信模板详情响应体。

{
  "status" : "Normal",
  "template_name" : "模板测试AAB",
  "template_type" : "PROMOTION_TYPE",
  "template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ",
  "template_id" : "1512***3",
  "signature_id" : "65ba0c56-aa84-4e68-86a7-****62c50707",
  "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af",
  "app_name" : "NewOPACCOUNT082",
  "create_time" : "2023-08-08 06:14:56",
  "has_variable" : "Yes",
  "flow_status" : "Reviewing",
  "universal_template" : null,
  "template_desc" : "模板测试",
  "urge_status" : "NO",
  "urge_time" : null,
  "urge_desc" : null,
  "review_desc" : null
}

状态码

状态码

描述

200

获取短信模板详情响应体。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 短信模板

相关文档