云消息服务 KOOMESSAGE-查询模板:响应参数

时间:2024-11-22 10:18:09

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

templates

Array of AIMTemplate objects

模板列表。

page_info

Page object

分页信息。

表4 AIMTemplate

参数

参数类型

描述

tpl_id

String

智能信息模板ID。

说明:

智能信息平台生成的模板ID,由9位数字组成。

tpl_name

String

智能信息模板名称。

scene

String

场景类型。

tpl_state

Integer

模板状态。

  • 0:禁用

  • 1:启用

disable_desc

String

禁用原因。

disable_time

String

禁用时间。样例:1970-01-01T00:00 :00Z。

audit_state

Integer

审核状态。

  • 0:未提交

  • 1:审核中

  • 2:审核通过

  • 3:审核失败

audit_desc

String

审批信息。

description

String

短信示例。

说明:

对应创建个人模板API中的入参sms_example。

creation_time

String

创建时间。样例为:1970-01-01T00:00:00Z。

update_time

String

更新时间。样例为:1970-01-01T00:00:00Z。

pages

String

模板页面HTML,JSON格式。

params

Array of AIMTemplateParams objects

模板动态参数列表。

factory_info

Array of FactoryInfo objects

支持厂商列表。

match_type

Integer

模板类型。

  • 1:短链解析模板

  • 2:文本识别模板

  • 4:一体化模板

card_id

String

布局类型。

sub_type

Integer

版式子类型。

preview_url

String

模板二维码预览地址。

表5 AIMTemplateParams

参数

参数类型

描述

type

String

参数类型。

  • string:文本

  • integer:数字

name

String

参数名称。

has_length

Boolean

动态参数是否长度限制。

  • false:不可设置

  • true:可设置

fix_length

Integer

固定长度。

length_restrict

Boolean

长度限制。

min_length

Integer

最小长度。

max_length

Integer

最大长度。

表6 FactoryInfo

参数

参数类型

描述

factory_type

String

厂商名称。

state

Integer

厂商状态。

  • 0:禁用

  • 1:启用

  • 2:未启用

version

String

厂商版本。

tpl_id

String

智能信息模板ID。

表7 Page

参数

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,offset大于等于0。

limit

Integer

每页显示的条目数量。

total

Integer

总条数。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明:

该字段在以后可能会废弃,建议使用error_msg字段对接。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明:

该字段在以后可能会废弃,建议使用error_msg字段对接。

support.huaweicloud.com/api-koomessage/ListAIMTemplates.html