云消息服务 KOOMESSAGE-华为云

云消息服务 KOOMESSAGE-认识KooMessage控制台

认识 KooMessage 控制台用户开通KooMessage服务后，进入KooMessage控制台，默认进入“总览”页面。总览页面会显示：购买套餐包：单击“购买套餐包”，进入购买页面，具体可参见购买KooMessage套餐包。流程指引：显示智能信息、智能信息基础版、智能信息服务号等流程指引，根据需要，按照指引操作。查看套餐包详情：页面显示各服务购买的套餐详情，可以查看套餐余量、可使用的套餐包信息等。更多信息请参考套餐包。图1 总览如果当前用户有正在使用的解析标识，会在页面顶部显示解析标识的使用信息，示例如图2，单击“查看详情”会跳转至“解析任务管理”页面。图2 总览（解析标识）

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-开通KooMessage服务:开通KooMessage服务

开通KooMessage服务进入KooMessage官网首页。登录KooMessage控制台，进入开通KooMessage服务页面。勾选“我已阅读并同意《KooMessage服务使用声明》《短信服务使用声明》”，单击“立即开通”。 KooMessage服务只向通过认证的企业提供开通，如还未完成企业用户认证，请单击“去认证企业用户”进行认证。如果当前账号未绑定邮箱，请单击“去绑定”，可以快速地绑定邮箱，再继续开通KooMessage服务。绑定邮箱后，需要3个工作日审核，请耐心等待。图1 开通KooMessage服务开通成功后进入控制台首页，且后续直接登录使用无需再开通。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-上传智能信息服务号图片资源:响应参数

响应参数状态码： 200 表2 响应Body参数参数参数类型描述 data UploadMediaRsp object 上传智能信息服务号图片资源响应体。表3 UploadMediaRsp 参数参数类型描述 resource_type Integer 资源类型。 1：图片 resource_id String 资源ID。 resource_url String 资源路径。状态码： 400 表4 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 结果详情。状态码： 500 表5 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 结果详情。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-上传智能信息服务号图片资源:响应示例

响应示例状态码： 200 返回信息。 { "data" : { "resource_id" : "708feafdf1354805bd66e7fddc678dc3", "resource_type" : null, "resource_url" : "AimSauploadService/0ee8432935c84290bd67993ac7059ed720220530-141334( WeLink PC).png" } }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-上传智能信息服务号图片资源:请求参数

请求参数表1 FormData参数参数是否必选参数类型描述 file 是 File 图片资源。说明：文件格式与文件名后缀需保持一致，请勿修改原始文件后缀，否则导致资源上传失败。 file_type 是 String 文件类型。 PUB_ LOG O：上传服务号LOGO。支持jpg、bmp、png和jpeg格式，分辨率大于等于240*240且比例为1:1，大小不超过100k。 BG_IMAGE：上传服务号主页背景图。支持jpg、bmp、png和jpeg格式，分辨率大于等于1440*810且比例为16:9，大小不超过4M。 FASTAPP_LOGO：上传快应用LOGO。支持jpg、bmp、png和jpeg格式，分辨率大于等于192*192且比例为1:1，大小不超过4M。 OTHER：上传授权证明和营业执照等。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-修改主页信息:请求示例

请求示例根据主页ID修改主页信息。设置修改原因为"我想修改主页"，修改主页背景图片资源ID为"1d191b06da9a485895e10e48cbc5cccc"，快应用跳转地址为"hap://app/122"。 https://koomessage.myhuaweicloud.com/v1/aim-sa/portals/bcce7e60df6445a592c09ca95dfdcccc { "change_reason" : "我想修改主页", "background_img" : "1d191b06da9a485895e10e48cbc5cccc", "summary" : "测试-欢迎来到酷玩影视", "tels" : [ { "tel" : "131****0000", "usage" : "加入我们" }, { "tel" : "131****0001", "usage" : "联系我们" } ], "fastapps" : [ { "name" : "酷玩", "description" : "这是一个快应用的描述", "deeplink" : "hap://app/122", "depend_engine_version" : "1", "logo_img" : "d2fe995119584f88be9e9ef53d2ccccc" } ] }

云消息服务 KOOMESSAGE 智能信息服务号主页

云消息服务 KOOMESSAGE-修改主页信息:响应参数

响应参数状态码： 200 表6 响应Body参数参数参数类型描述 data UpdatePortalRsp object 修改主页信息响应体。表7 UpdatePortalRsp 参数参数类型描述 portal PortalModel object 主页信息。表8 PortalModel 参数参数类型描述 portal_id String 主页ID。 company_id String 企业ID。 company_name String 企业名称。 pub_id String 服务号ID。 pub_name String 服务号名称。 background_img String 主页背景图片资源ID。 background_img_url String 背景图片URL。 summary String 简介。 tels String 热线号列表。说明：以JSON列表返回，格式： {"tel": "400-800-8800", "usage": "官方服务电话"}。 fastapps String 快应用列表。说明：以JSON列表返回，格式： {"name": "快应用名称","logo_img": "快应用LOGO图片资源ID", "logo_img_url": "快应用LOGO图片资源URL", "description": "快应用描述","deeplink": "hap://app/fastapp","depend_engine_version": "1040"}。 state Integer 主页状态。 1：未生效 2：已生效 3：已失效 4：服务号已冻结 approve_state Integer 审核状态。 1：待审核 2：通过 3：驳回 online_time String 上线时间。 creator String 创建人。 create_time String 创建时间。 change_reason String 修改原因。状态码： 400 表9 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 结果详情。状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 结果详情。

云消息服务 KOOMESSAGE 智能信息服务号主页

云消息服务 KOOMESSAGE-修改主页信息:响应示例

响应示例状态码： 200 返回信息。 { "data" : { "portal" : { "portal_id" : "bcce7e60df6445a592c09ca95dfdcccc", "state" : 1, "approve_state" : 1, "company_id" : "cf2d298c555e44bf9fafdf5ada0ccccc", "company_name" : "南派餐饮", "creator" : "7139bc07d53240dca88722930485cccc", "create_time" : "2022-08-08T01:49:29Z", "change_reason" : "我想修改主页", "pub_id" : "961b0f7d32314b5cb287fc06fe09cccc", "pub_name" : "服务号名称", "background_img" : "1d191b06da9a485895e10e48cbc5cccc", "background_img_url" : "AimSauploadService/ad63cdaa3a044a589bbde7f6a4551111.png", "summary" : "测试-欢迎来到酷玩影视", "tels" : "[{\"usage\":\"加入我们\",\"tel\":\"131****0000\"},{\"usage\":\"联系我们\",\"tel\":\"131****0001\"}]", "fastapps" : "[{\"name\":\"酷玩\",\"logo_img\":\"d2fe995119584f88be9e9ef53d2ccccc\",\"logo_img_url\":\"AimSauploadService/ccccd328eba84b27ab215122aada398ftest22_192x192 (1).jpg\",\"description\":\"这是一个快应用的描述\",\"deeplink\":\"hap://app/122\",\"depend_engine_version\":\"1\"}]", "approve_time" : null, "online_time" : null } } }

云消息服务 KOOMESSAGE 智能信息服务号主页

云消息服务 KOOMESSAGE-修改主页信息:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 change_reason 是 String 修改原因。最小长度：5 最大长度：50 background_img 是 String 主页背景图片资源ID。分辨率大于等于1440*810，支持jpg、jpeg、bmp、png。参数值为上传智能信息服务号图片资源API返回的resource_id。最小长度：32 最大长度：32 summary 是 String 简介。最小长度：1 最大长度：75 tels 否 Array of TelModel objects 热线号列表。数组长度：0 - 5 fastapps 否 Array of UpdatePortalFastappModel objects 快应用列表。数组长度：0 - 10 hw_pubs 否 Array of strings 华为服务号列表。说明：预留，暂未使用。数组长度：0 - 10 表4 TelModel 参数是否必选参数类型描述 tel 是 String 电话号码（只能包含数字和“-”，且开头和结尾必须为数字）。最小长度：1 最大长度：20 usage 是 String 号码用途。说明：号码用途长度范围为1-30个字符，中文占2个字符，英文占1个字符。表5 UpdatePortalFastappModel 参数是否必选参数类型描述 name 是 String 快应用名。说明：长度范围为1-30个字符，中文占2个字符，英文占1个字符。 logo_img 是 String 快应用LOGO图片资源ID。说明：图片格式为jpg、bmp、jpeg，分辨率大于等于192*192，大小不超过4M。参数值为上传智能信息服务号图片资源API返回的resource_id。最小长度：32 最大长度：32 description 是 String 快应用描述。说明：长度范围为1-38个字符，中文占2个字符，英文占1个字符。 deeplink 是 String 快应用跳转链接。最小长度：1 最大长度：1000 depend_engine_version 是 String 快应用依赖引擎版本。说明：长度范围为1-50个字符，中文占2个字符，英文占1个字符。

云消息服务 KOOMESSAGE 智能信息服务号主页

云消息服务 KOOMESSAGE-查询智能消息模板素材列表:响应示例

响应示例状态码： 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 } ] } }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-查询智能消息模板素材列表:URI

URI GET /v1/aim/template-materials 表1 Query参数参数是否必选参数类型描述 resource_type 是 String 资源类型。 image：表示图片 video：表示视频最小长度：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

云消息服务 KOOMESSAGE

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

响应参数状态码： 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 结果详情。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-上传智能信息模板素材:请求示例

请求示例上传个人模板素材-图片。类型为"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..." }

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-上传智能信息模板素材:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 status String 请求状态，固定200。 message String 状态描述。 data UploadTemplateMaterialDataResponse object 上传模板素材响应对象。表4 UploadTemplateMaterialDataResponse 参数参数类型描述 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 结果详情。

云消息服务 KOOMESSAGE

云消息服务 KOOMESSAGE-上传智能信息模板素材:请求参数

请求参数表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

云消息服务 KOOMESSAGE

云服务器内容精选

云消息服务 KOOMESSAGE

7*24

备案

专业服务

退订

建议反馈

售前咨询热线