查询智能消息模板素材列表
功能介绍
根据用户提供的过滤条件，查询模板素材列表。
URI
GET /v1/aim/template-materials
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
资源类型。
最小长度：1 最大长度：16 |
|
file_name |
否 |
String |
文件名称。 最小长度：0 最大长度：100 |
|
material_id |
否 |
String |
素材ID。 最小长度：0 最大长度：36 |
|
aim_resource_id |
否 |
String |
资源ID。 最小长度：0 最大长度：64 |
|
offset |
是 |
Integer |
翻页页数，从1开始。 最小值：1 最大值：1000 |
|
limit |
是 |
Integer |
每页展示的条数。 最小值：1 最大值：1000 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
请求状态，固定200。 |
|
message |
String |
状态描述。 |
|
data |
ListTemplateMaterialResponse object |
返回模板素材列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page_info |
PageInfo object |
分页信息。 |
|
results |
Array of Material objects |
模板素材列表。 数组长度：0 - 100 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
素材ID。 |
|
created_at |
String |
创建时间。 |
|
resource_type |
String |
资源类型。
|
|
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 |
图像比例。
|
|
description |
String |
素材详细描述。 |
|
thumbnail |
Thumbnail object |
文件缩略图。 |
|
domain_id |
String |
租户ID。 |
|
size |
Integer |
素材所占空间大小。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
缩略图ID。 |
|
created_at |
String |
创建时间。 |
|
is_primary |
Integer |
是否作为视频素材封面。
|
|
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 |
图像比例。
|
|
is_auto_gen |
Integer |
缩略图是否自动从系统生成。 |
|
description |
String |
缩略图的详细描述。 |
|
size |
Integer |
缩略图所占空间大小。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 |
|
error_msg |
String |
结果详情。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 |
|
error_msg |
String |
结果详情。 |
请求示例
查询模板素材。
https://koomessage.myhuaweicloud.com/v1/aim/template-materials?resource_type=image&offset=1&limit=2
响应示例
状态码： 200
返回信息。
{
"status" : "200",
"message" : "success",
"data" : {
"page_info" : {
"offset" : 1,
"limit" : 2,
"total" : 185
},
"results" : [ {
"id" : "2bb938ae-33d0-4429-a849-458e650b9d76",
"created_at" : "2022-06-01 23:13:09.0",
"resource_type" : "image",
"file_name" : "2_cropped_ducky.jpg",
"aim_resource_id" : "691996319597764608",
"obs_object_key" : "2_cropped_ducky-698756331828305.jpg",
"obs_file_url" : "https://cn-north-4-km-template.obs.cn-north-4.myhuaweicloud.com:443/2_cropped_ducky-698756331828305.jpg?AccessKeyId=NTC2D0Y60ZYE54XXT23R&Expires=1655431901&Signature=FatQpd3PHMjMV5KaDzxaySseLKI%3D",
"image_rate" : "oneToOne",
"description" : null,
"thumbnail" : null
}, {
"id" : "9ce7491f-b991-4789-95ed-d4ca2b505c73",
"created_at" : "2022-06-01 23:13:08.0",
"resource_type" : "image",
"file_name" : "2_cropped_ducky.jpg",
"aim_resource_id" : "691996313788653569",
"obs_object_key" : "2_cropped_ducky-698683534539006.jpg",
"obs_file_url" : "https://cn-north-4-km-template.obs.cn-north-4.myhuaweicloud.com:443/2_cropped_ducky-698683534539006.jpg?AccessKeyId=NTC2D0Y60ZYE54XXT23R&Expires=1655431901&Signature=P6xQaLtJkW7mpd1b2Mwde3Zmv2k%3D",
"image_rate" : "oneToOne",
"description" : null,
"thumbnail" : null
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回信息。 |
|
400 |
非法参数。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
