文档首页> 消息&短信 MSGSMS> API参考> API> 应用、签名、模板API> 短信模板API> 查询模板变量
更新时间：2023-08-25 GMT+08:00
查看PDF
分享

查询模板变量

功能介绍

该接口用于用户查询模板参数。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/msgsms/templates/{id}/varilable

表1 路径参数

参数

是否必选

参数类型

描述

id

是

Integer

模板主键ID，对应表5中的id

project_id

是

String

项目ID，参考“获取帐号、用户、项目的名称和ID”

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

X-Auth-Token

是

String

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

响应参数

表3 响应Body参数

参数

参数类型

描述

results

Array of ApiTemplateVariable

查询结果

total

Long

总数
表4 ApiTemplateVariable

参数

是否必选

参数类型

描述

id

否

Integer

变量id

User_name

否

String

用户名

temp_name

否

String

模板名称

variable_index

否

Integer

变量索引

variable_type

否

String

变量类型

variable_length

否

Integer

变量长度

variable_desc

否

String

变量描述

请求示例

查询模板变量，请求方式：GET ，请求URL：/v2/{project_id}/msgsms/templates/{id}/varilable，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type。

GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/f063a294-06ab-420e-90bc-0c4dd9aed540/varilable 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******

响应示例

{
    "results": [
        {
            "id": 15003394,
            "temp_name": "测试",
            "variable_index": 1,
            "variable_type": "URL",
            "variable_length": 99,
            "variable_desc": ""
        }
    ],
    "total": 1
}

返回值

返回值

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

System error
父主题： 短信模板API
分享：

    相关文档

    相关产品