# 上传智能信息模板素材 #### 功能介绍 支持用户上传模板使用的图片或者视频。 ![](https://support.huaweicloud.com/api-koomessage/public_sys-resources/note_3.0-zh-cn.png) 单个租户资源空间为10GB，包括回收站内容，系统会自动删除30天未使用的资源并释放其内存，请及时清理无用资源，防止资源浪费。 请求中所有字符串不允许携带"\<"、"\>"或多个空格。 #### URI POST /v1/aim/template-materials #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | 请求体参数类型，该字段必须设置为：application/json。 | | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_type | 是 | String | 资源类型。 - image：图片 - video：视频 - thumbnail：缩略图 说明： 图片支持png、jpeg、jpg格式，最大2M; 视频支持格式mp4，大小不超过7M，建议时长不超过33S; 缩略图支持png、jpeg、jpg格式，大小不超过100K。 最小长度：**1** 最大长度：**16** | | material_id | 否 | String | 素材ID。 说明： resource_type=thumbnail时，material_id必填，填写内容为上传视频资源返回的material_id字段的值。 最小长度：**0** 最大长度：**36** | | file_type | 是 | String | 文件类型。 - url：资源为URL链接地址 - stream：资源为多媒体资源文件流的BASE64编码，需要带资源类型前缀，样例："data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gIoSUNDX1BST0ZJTEUAAQEAAAIYAAAAAAQwAABtbnRyUkdCIFhZWiAAAAAAAAAAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQ..."，样例过长，未显示全部。 最小长度：**1** 最大长度：**16** | | file_url | 否 | String | 文件URL。 说明： file_type=url时，file_url为必填。URL地址必须包含文件格式的后缀，例如：jpg、jpeg，大小写后缀都支持。 最大长度：**1000** | | file_stream | 否 | String | 文件资源码流。 说明： file_type=stream时，file_stream为必填。 | | image_rate | 否 | String | 图像比例。 - oneToOne：指1:1比例 - sixteenToNine：指16:9比例 - threeToOne：指3:1比例 - fortyEightToSixtyFive：指48:65比例 - twentyOneToNine：指21:9比例 - threeToFour：指3:4比例 说明： resource type=image时，image_rate必填。 最大长度：**32** | | file_name | 否 | String | 文件名称。 说明： file_type=stream时，file_name必填。 最大长度：**200** | | description | 否 | String | 描述。 最大长度：**50** | #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | 请求状态，固定200。 | | message | String | 状态描述。 | | data | [UploadTemplateMaterialDataResponse] object | 上传模板素材响应对象。 | 表4UploadTemplateMaterialDataResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | material_id | String | 模板素材ID。 | | aim_resource_id | String | 资源ID。 | **状态码： 400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 结果状态码。 | | error_msg | String | 结果详情。 | **状态码： 500** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 结果状态码。 | | error_msg | String | 结果详情。 | #### 请求示例 - 上传个人模板素材-图片。类型为"image"，文件名称为"template_image.jpg"。 ``` https://koomessage.myhuaweicloud.cn/v1/aim/template-materials { "resource_type" : "image", "file_type" : "stream", "image_rate" : "oneToOne", "file_name" : "template_image.jpg", "file_stream" : "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gIoSUNDX1BST0ZJTEUAAQEAAAIYAAAAAAQwAABtbnRyUkdCIFhZWiAAAAAAAAAAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQ..." } ``` - 上传个人模板素材-视频。类型为"video"，文件名称为"template_video.mp4"。 ``` https://koomessage.myhuaweicloud.cn/v1/aim/template-materials { "file_name" : "template_video.mp4", "resource_type" : "video", "file_type" : "stream", "file_stream" : "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wNDEAADhJbW9vdgAAAGxtdmhkAAAAAAAAAAAAAAAAAAAD6AAAUoUAAQAAAQAAAAAAAAAAAAAAAAEAAAAAAAAAAAAA..." } ``` - 上传个人模板素材-缩略图(视频封面)。类型为"thumbnail"，文件名称为"template_thumbnail.jpg"。 ``` https://koomessage.myhuaweicloud.cn/v1/aim/template-materials { "resource_type" : "thumbnail", "material_id" : "b68de572-edd2-4c9e-8b34-8457a8e5cccc", "file_type" : "stream", "file_name" : "template_thumbnail.jpg", "file_stream" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAcAAAAD8CAYAAADg6nQRAAAAAXNSR0IArs4c6QAAIABJREFUeF7sveurbdu23dXHXPtxRBT8YBAUVBRRVAQ/iOIDDaigEPX6SMgDiSbRiy..." } ``` #### 响应示例 **状态码： 200** 返回信息。 ``` { "status" : "200", "message" : "success", "data" : { "material_id" : "24267112-21d7-468f-aa58-eaf00af2d3b2", "aim_resource_id" : "123df45-fgfg3456-g34d" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 返回信息。 | | 400 | 非法参数。 | | 500 | 内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koomessage/ErrorCode.html)。