查询智能信息基础版模板状态
功能介绍
根据用户提供的过滤条件查询智能信息基础版模板状态列表。
包括：模板ID、模板名称等。
URI
GET /v1/aim-basic/templates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
tpl_id |
否 |
String |
智能信息基础版模板ID。 |
|
tpl_name |
否 |
String |
智能信息基础版模板名称。 |
|
tpl_type |
否 |
String |
智能信息基础版模板分类。
|
|
has_param |
否 |
Boolean |
智能信息基础版模板是否携带参数，不传查全部模板。 |
|
begin_time |
否 |
String |
智能信息基础版模板创建开始时间。 样例为：2019-10-12T07:20:50Z。
说明：
begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 |
|
end_time |
否 |
String |
智能信息基础版模板创建结束时间。 样例为：2019-10-12T07:20:50Z。
说明：
begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 |
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：1000000 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量。 最小值：1 最大值：100 缺省值：20 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
请求状态，固定200。 |
|
message |
String |
状态描述。 |
|
data |
GetTemplateStatusResult object |
查询智能信息基础版模板状态响应。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
templates |
Array of VmsTemplateStatus objects |
智能信息基础版模板列表。 数组长度：0 - 200 |
|
page_info |
Page object |
分页信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
tpl_id |
String |
智能信息基础版模板ID。 |
|
audit_state |
Integer |
智能信息基础版审核状态。
|
|
audit_desc |
String |
智能信息基础版模板状态的描述，若状态是审核不通过或被禁用，描述表示的是不通过或禁用的原因。
说明：
长度不超过 1024 字。 |
|
tpl_size |
Integer |
智能信息基础版模板的大小。
说明：
单位：字节。 |
|
valid_time |
String |
模板截止有效日期，格式：yyyy-MM-ddTHH:mm:ssZ，0：表示永久有效。样例：2020-01-31T23:59:59Z。 |
|
status_detail |
Array of StatusDetail objects |
运营商的模板状态详情。 |
|
preview_url |
String |
智能信息基础版模板预览地址。 |
|
tpl_name |
String |
智能信息基础版模板名称。 |
|
title |
String |
智能信息基础版模板主题。 |
|
tpl_sign |
String |
智能信息基础版模板签名。 |
|
create_time |
String |
智能信息基础版模板创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。 |
|
var_info |
Array of VarInfo objects |
智能信息基础版模板动参信息，静态模板没有动参，该字段填空。 |
|
restags |
String |
资源分配标签，取值如下：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
carrier |
String |
运营商类型。
|
|
status |
Integer |
模板状态：
|
|
desc |
String |
对模板状态的描述。
说明：
若状态是审核不通过或被禁用，描述表示的是不通过或禁用的原因。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
动参变量占位符名称。
说明：
格式：#p_N#（N表示第几个参数，与模板文件占位名称保持一致），如：#p_1#。 |
|
type |
String |
动参变量类型。
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0。 |
|
limit |
Integer |
每页显示的条目数量。 |
|
total |
Integer |
总条数。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 |
|
error_msg |
String |
结果详情。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 |
|
error_msg |
String |
结果详情。 |
请求示例
查询智能信息基础版模板状态，模板类型为公共模板。
https://koomessage.myhuaweicloud.cn/v1/aim-basic/templates?limit=20&offset=1&tpl_type=public
响应示例
状态码： 200
查询智能信息基础版模板状态返回体。
{
"status" : "200",
"message" : "success",
"data" : {
"templates" : [ {
"tpl_id" : "800000001",
"tpl_name" : "测试-正能量",
"title" : null,
"tpl_sign" : "华为云",
"tpl_size" : 0,
"audit_state" : 3,
"audit_desc" : "模板签名被禁用",
"create_time" : "2022-07-01T14:58:06Z",
"valid_time" : "2022-09-29T23:59:59Z",
"preview_url" : "https://rcos.800ct.com:57156/preview/27Em/6592288c6f55da18296824f9d806ddab.html",
"restags" : "三网一般",
"var_info" : [ {
"type" : "txt",
"name" : "#p_1#"
} ],
"status_detail" : [ {
"carrier" : "cmcc",
"status" : 0,
"desc" : "正常可用"
}, {
"carrier" : "ctcc",
"status" : 3,
"desc" : "模板已禁用"
}, {
"carrier" : "cucc",
"status" : 0,
"desc" : "正常可用"
} ]
} ],
"page_info" : {
"offset" : 0,
"limit" : 20,
"total" : 1
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询智能信息基础版模板状态返回体。 |
|
400 |
非法参数。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
