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

查询短信模板变量

功能介绍

该接口用于用户查询短信模板变量。

URI

GET /v1/sms/templates/{template_id}/variable

表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参数

参数

参数类型

描述

results

Array of VariableAttributesResponse objects

返回结果列表。

total

Integer

总数。
表4 VariableAttributesResponse

参数

参数类型

描述

id

Integer

ID。

variable_index

Integer

变量索引。

variable_length

Integer

变量长度。

variable_type

String

变量类型。

最小长度：1

最大长度：20

variable_desc

String

变量描述。

最小长度：0

最大长度：100

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

最小长度：0

最大长度：32

error_msg

String

结果详情。

最小长度：0

最大长度：32

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

最小长度：0

最大长度：32

error_msg

String

结果详情。

最小长度：0

最大长度：32

请求示例

查询ID为"1512***3"的模板变量列表。

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

响应示例

状态码： 200

查询短信模板变量列表响应体。

{
  "results" : [ {
    "id" : 15005872,
    "variable_index" : 1,
    "variable_length" : 99,
    "variable_type" : "NEWTEXT",
    "variable_desc" : "直发"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

查询短信模板变量列表响应体。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 短信模板

相关文档