云消息服务 KooMessage-查询智能消息模板素材列表:响应参数

时间:2025-02-12 15:01:30

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

请求状态,固定200。

message

String

状态描述。

data

ListTemplateMaterialResponse object

返回模板素材列表。

表4 ListTemplateMaterialResponse

参数

参数类型

描述

page_info

PageInfo object

分页信息。

results

Array of Material objects

模板素材列表。

数组长度:0 - 100

表5 PageInfo

参数

参数类型

描述

offset

Integer

翻页页数,从1开始。

limit

Integer

每页展示的条数。

total

Integer

总条数。

表6 Material

参数

参数类型

描述

id

String

素材ID。

created_at

String

创建时间。

resource_type

String

资源类型。

  • image:表示图片

  • video:表示视频

  • thumbnail:表示缩略图

file_name

String

文件名称。

aim_resource_id

String

资源ID。

obs_object_key

String

从OBS返回的文件Key。

obs_file_url

String

文件访问路径。

obs_bucket_name

String

OBS桶名称。

image_rate

String

图像比例。

  • oneToOne:指1:1比例

  • sixteenToNine:指16:9比例

  • threeToOne:指3:1比例

  • fortyEightToSixtyFive:指48:65比例

  • twentyOneToNine:指21:9比例

  • threeToFour:指3:4比例

description

String

素材详细描述。

thumbnail

Thumbnail object

文件缩略图。

domain_id

String

租户ID。

size

Integer

素材所占空间大小。

表7 Thumbnail

参数

参数类型

描述

id

String

缩略图ID。

created_at

String

创建时间。

is_primary

Integer

是否作为视频素材封面。

  • 0:否

  • 1:是

resource_type

String

资源类型,image:表示图片。

file_name

String

文件名称。

aim_resource_id

String

资源ID。

obs_object_key

String

从OBS返回的文件Key。

obs_file_url

String

文件访问路径。

image_rate

String

图像比例。

  • oneToOne:指1:1比例

  • sixteenToNine:指16:9比例

  • threeToOne:指3:1比例

  • fortyEightToSixtyFive:指48:65比例

  • twentyOneToNine:指21:9比例

  • threeToFour:指3:4比例

is_auto_gen

Integer

缩略图是否自动从系统生成。

description

String

缩略图的详细描述。

size

Integer

缩略图所占空间大小。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

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