华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

请求示例 修改ID为"1512***3"的短信模板。 https://koomessage.myhuaweicloud.cn/v1/sms/templates/1512***3 { "signature_id" : "65ba0c56-aa84-4e68-86a7-38af62c50707", "template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ", "template_desc" : "模板测试", "template_name" : "模板测试AAB", "template_type" : "NOTIFY_TYPE", "universal_template" : 0, "variable_attributes" : [ { "variable_index" : 1, "variable_type" : "NEWTEXT", "variable_desc" : "直发" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 template_id String 模板ID。 最小长度：1 最大长度：50 template_name String 模板名称。 最小长度：1 最大长度：30 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 否 String 应用ID，默认取签名所属的应用ID。 最小长度：1 最大长度：50 signature_id 是 String 签名ID。 最小长度：1 最大长度：50 template_content 是 String 模板内容。 最小长度：1 最大长度：500 template_desc 否 String 模板描述。 最小长度：1 最大长度：100 template_name 是 String 模板名称。 最小长度：1 最大长度：30 template_type 否 String 模板类型。默认取所属签名的签名类型。 最小长度：1 最大长度：20 枚举值： PROMOTION_TYPE：营销类 NOTIFY_TYPE：通知类 universal_template 否 String 是否为通用模板(暂不支持通用模板)。 缺省值：0 最小长度：1 最大长度：10 枚举值： 0：非通用模板 1：通用模板 variable_attributes 是 Array of VariableAttributes objects 模板参数。 数组长度：1 - 20 表4 VariableAttributes 参数 是否必选 参数类型 描述 variable_index 是 Integer 参数索引。 variable_type 是 String 参数类型。 最小长度：1 最大长度：20 枚举值： PHONE：电话号码 NEWTEXT：解析标识 CHARDIGIT：其他号码(如验证码、订单号、密码等) DATETIME：日期时间 MONEY：金额 TEXT：其他 variable_desc 否 String 参数描述。变量类型为TEXT（其他）时必填。 最小长度：0 最大长度：100

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 data PortalPushResponseBody object 主页催审返回体。 表3 PortalPushResponseBody 参数 参数类型 描述 data data object 消息体。 表4 data 参数 参数类型 描述 log_id String 主页申请记录ID。 message String 返回信息。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 请求成功返回的数据，为JSON格式。 数组长度：0 - 2147483647 表5 data 参数 参数类型 描述 pub_id String 服务号ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 表3 请求Body参数 参数 是否必选 参数类型 描述 change_reason 是 String 解冻原因。 最小长度：1 最大长度：200

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

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

请求参数 表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：上传授权证明和营业执照等。

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

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

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

请求示例 一站式创建智能信息服务号。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/unify/pubs { "pub_request_body" : { "logo_img" : "651029053e15443eb5e26e1f4495cccc", "pub_name" : "服务号名称", "pub_abstract" : "服务号摘要", "pub_remark" : "服务号备注", "auto_get_port" : 1, "signs_for_auto_get_port" : [ "短信签名" ], "areas_for_auto_get_port" : [ "四川省", "佛山市" ], "industry" : 1, "authorization_files" : [ "0315f966f362400d9b2f369aef98cccc" ] }, "portal_request_body" : { "background_img" : "6d5eb6dc1c1a4fa6a240671e0845cccc", "summary" : "主页简介", "tels" : [ { "tel" : "131****0000", "usage" : "官网电话用途" } ], "fastapps" : [ { "name" : "主页快应用", "logo_img" : "651029053e15443eb5e26e1f4495cccc", "description" : "快应用简介", "deeplink" : "hap://app/fastapp1", "depend_engine_version" : "1040" } ], "hw_pubs" : null }, "menu_request_body" : { "menu" : { "menu_items" : [ { "name" : "打开商城", "action_type" : "OPEN_URL", "content" : "https://www.example.com/", "ext_msg" : { "web_title" : "百度百度", "open_in_browser" : 1 }, "sub_menu_items" : [ ] }, { "action_type" : "OPEN_SUBMENU", "name" : "联系我们", "content" : null, "ext_msg" : { }, "sub_menu_items" : [ { "action_type" : "OPEN_URL", "name" : "百度一下", "sub_menu_items" : [ ], "content" : "https://www.example.com/", "ext_msg" : { "web_title" : "url标题", "open_in_browser" : 1 } } ] } ] } } }

响应示例 状态码： 200 返回信息。 { "data" : { "data" : { "pub_id" : "5467ec75eb974f508cee2cee10a7cccc", "menu_id" : "b1323ef35b8f4ee3a6767fa5b6cbcccc", "portal_id" : "71233b4208194db991e0ec091f23cccc", "log_id" : "14458", "pub_name" : "服务号名称" } } }

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 data PubCreateResponse object 创建服务号的返回值。 表12 PubCreateResponse 参数 参数类型 描述 data data object 响应实体类。 表13 data 参数 参数类型 描述 log_id String 服务号申请记录ID。 pub_id String 服务号ID。 menu_id String 菜单ID。 portal_id String 主页ID。 pub_name String 服务号名称。 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 表2 请求Body参数 参数 是否必选 参数类型 描述 pub_request_body 是 PubCreateRequestBody object 创建服务号的请求体。 portal_request_body 是 PortalRequestBody object 创建主页的请求体。 menu_request_body 是 MenuRequestBody object 创建菜单的请求体。 表3 PubCreateRequestBody 参数 是否必选 参数类型 描述 logo_img 是 String 服务号LOGO图片ID。 说明： 通过上传智能信息服务号图片资源接口上传LOGO图片后获得的图片resource_id。图片要求大于等于240*240且比例相同。 最小长度：32 最大长度：32 pub_name 是 String 服务号名称。 说明： 同一个企业下可以相同，不同企业下不能重复。 最小长度：1 最大长度：15 pub_abstract 是 String 服务号简介。 最小长度：1 最大长度：75 pub_remark 否 String 服务号备注。 说明： 同一个企业下，服务号名称相同时该项必须不同。 最小长度：1 最大长度：15 auto_get_port 否 Integer 是否授权系统自动收集端口。 0：否 1：是 最小值：0 最大值：1 缺省值：0 signs_for_auto_get_port 否 Array of strings 自动收集端口使用的签名列表。 说明： auto_get_port为1时，该字段为必填，每个签名长度为2-18个字符，每个服务号签名不可以重复。 最小长度：2 最大长度：18 数组长度：0 - 5 industry 否 Integer 从事行业，默认取服务号所属商家的行业分类。 1：金融理财 2：社交通讯 3：影音娱乐 4：旅游出行 5：购物 6：本地生活 7：运动健康 8：教育培训 9：新闻阅读 10：运营商 11：其他 最小值：1 最大值：11 authorization_files 是 Array of strings 授权证明图片ID，支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M，最多支持6张。 说明： 参数值为上传智能信息服务号图片资源API返回的resource_id。 数组长度：0 - 6 areas_for_auto_get_port 否 Array of strings 自动收集端口生效的地区列表。地区取值见《地区名称列表》。 说明： auto_get_port为1时，该字段有效。不填则默认全国，不允许传入重叠地区。 表4 PortalRequestBody 参数 是否必选 参数类型 描述 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 CreatePubFastappModel objects 快应用列表。 数组长度：0 - 10 hw_pubs 否 Array of strings 华为服务号列表。 说明： 预留，暂未使用。 最小长度：1 最大长度：50 数组长度：0 - 10 表5 TelModel 参数 是否必选 参数类型 描述 tel 是 String 电话号码（只能包含数字和“-”，且开头和结尾必须为数字）。 最小长度：1 最大长度：20 usage 是 String 号码用途。 说明： 号码用途长度范围为1-30个字符，中文占2个字符，英文占1个字符。 表6 CreatePubFastappModel 参数 是否必选 参数类型 描述 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个字符。 表7 MenuRequestBody 参数 是否必选 参数类型 描述 menu 是 MenusMode object 菜单对象。 表8 MenusMode 参数 是否必选 参数类型 描述 menu_items 是 Array of MenuItem objects 各子菜单项配置。 数组长度：0 - 3 表9 MenuItem 参数 是否必选 参数类型 描述 name 是 String 子菜单名称。 一级菜单名长度和菜单数量有关，具体约束为： 当菜单数量为1个时，菜单名长度范围在1-24个字符。 当菜单数量为2个时，菜单名长度范围在1-12个字符。 当菜单数量为3个时，菜单名长度范围在1-8个字符。 二级菜单名长度范围恒为1-16个字符。 说明： 以上字符区分中英文，一个中文占2个字符，字母和数字占1个字符，且同时生效的一组菜单内名称不能重复。 action_type 是 String 菜单动作类型。 OPEN_SUBMENU：打开子菜单 OPEN_URL：打开URL CALLING：拨打电话 OPEN_APP：打开APP OPEN_QUICK：打开快应用 最小长度：0 最大长度：30 content 否 String 对应值类型。对应不同action_type值，content含义如下： action_type=OPEN_SUBMENU：不填 action_type=OPEN_URL：参数数值为跳转URL action_type=CALLING：参数数值为电话号码 action_type=OPEN_APP：参数数值为APP的跳转deeplink action_type=OPEN_QUICK：参数数值为快应用跳转的deeplink 最小长度：0 最大长度：1000 ext_msg 否 ExtMsg object 额外需要携带的信息。 action_type=OPEN_SUBMENU时，不填 action_type=CALLING时，不填 action_type=OPEN_URL时，必填 action_type=OPEN_APP时，必填 action_type=OPEN_QUICK时，必填 sub_menu_items 否 Array of MenuItem objects 子菜单配置项。 说明： 仅当action_type=OPEN_SUBMENU时生效，且该项内不允许再配置子菜单。 数组长度：0 - 5 表10 ExtMsg 参数 是否必选 参数类型 描述 open_in_browser 否 String 打开方式。 0：webView打开 1：浏览器打开 说明： action_type=OPEN_URL必填，其他不填。 web_title 否 String 标题，必填，长度范围为1-20个字符。 说明： action_type=OPEN_URL必填，其他不填。 package_name 否 String app包名，长度范围为1-50个字符。 说明： action_type=OPEN_APP必填，其他不填。 app_id 否 String 商家应用的appid，长度范围为0-60个字符。 说明： action_type=OPEN_APP必填，其他不填。 browser_floor_url 否 String 兜底url，长度范围为0-1000个字符，支持http/https。 说明： action_type=OPEN_APP选填，其他不填。 depend_engine_ver 否 String 依赖的快应用引擎版本号，长度范围为1-50个字符。 说明： action_type=OPEN_QUICK必填，其他不填。 third_service_name 否 String 第三方服务名，长度范围为1-50个字符。 说明： action_type=OPEN_QUICK或OPEN_APP必填，其他不填。

请求示例 注册回执-智能信息单条发送回执 https://koomessage.myhuaweicloud.cn/v1/aim/callbacks { "callback_url" : "https://www.example.com/v1/send-resolve-status", "url_type" : 0 } 注册回执-智能信息模板状态回执 https://koomessage.myhuaweicloud.cn/v1/aim/callbacks { "callback_url" : "https://www.example.com/v1/template-status", "url_type" : 1 } 注册回执-智能信息批量发送回执 https://koomessage.myhuaweicloud.cn/v1/aim/callbacks { "callback_url" : "https://www.example.com/v1/send-resolve-status", "url_type" : 2 }

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : { "id" : "18d1bcad-4d13-4db1-bcdd-32565457cccc", "callback_url" : "https://www.example.com/v1/send-resolve-status" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data Callback object 注册详情。 status String 请求状态，固定200。 message String 状态描述。 表4 Callback 参数 参数类型 描述 callback_url String 回调地址。 id String 注册回调的唯一标识ID。 url_type Integer 回调类型。 0：智能信息单条发送回调 1：模板状态回调 2：智能信息批量发送回调 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 callback_url 是 String 回调地址。 说明： 必须http或https开头，建议使用https 支持 域名 或公网IP回调地址，不支持私网IP回调地址 最小长度：1 最大长度：1000 url_type 否 Integer 回调类型。 0：智能信息单条发送回调 1：模板状态回调 2：智能信息批量发送回调 缺省值：0

响应示例 状态码： 200 返回信息。 { "templates" : [ { "tpl_id" : "600000001", "tpl_name" : "测试-中行签到", "scene" : "测试模板", "tpl_state" : 1, "disable_desc" : "", "disable_time" : "1970-01-01T00:00:00Z", "audit_state" : 2, "audit_desc" : "审核通过", "description" : "您有一条新消息，测试。", "creation_time" : "2022-05-23T17:49:00Z", "update_time" : "2022-05-23T19:29:14Z", "pages" : "[{\"typeIndex\":0,\"cardId\":\"com.hbm.redpacket\",\"style\":{\"width\":\"342px\",\"opacity\":1,\"height\":\"456px\"},\"label\":\"主页1\",\"tag\":\"page1\",\"content\":[{\"visible\":true,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg.png\",\"h\":456,\"isBgimg\":true,\"type\":\"image\",\"skipReplaceSrc\":true,\"size\":0,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":0,\"notValid\":true,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.34403423289983026\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"\",\"longitude\":\"\"}},{\"serviceType\":0,\"visible\":false,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/defaultImg/defaultImg2.jpg\",\"h\":23,\"type\":\"serviceNumber\",\"serviceName\":\"请选择服务号\",\"skipReplaceSrc\":true,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":348,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"color\":\"#fff\",\"textAlign\":\"center\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.6574206986442455\",\"locked\":true,\"serviceID\":\"\"},{\"visible\":true,\"proportion\":[1,1],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/603264561/20220523174859881fILNZn.jpg\",\"bg\":{\"proportion\":[9,5],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/610579108/20220523174900022c8XeYT.jpg\",\"w\":342,\"h\":190},\"h\":70,\"type\":\"image\",\"oppobg\":{\"proportion\":[3,4],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg-oppo.jpg\",\"w\":342,\"h\":456},\"passItem\":false,\"size\":91289,\"borderRadius\":0,\"w\":70,\"x\":136,\"width\":1024,\"y\":44,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":\"70px\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.45509392249988934\",\"srcParam\":\"\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"latitude\":\"\",\"navType\":2,\"floorType\":0,\"description\":\"\",\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"browserFloorUrl\":\"\",\"merchantName\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"isBg\":0,\"height\":1024},{\"visible\":true,\"h\":23,\"title\":\"true\",\"type\":\"text\",\"textMaxlength\":36,\"passItem\":false,\"textOPPOLength\":24,\"w\":342,\"x\":0,\"y\":128,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"tag\":\"tg0.42763825585357296\",\"text\":\"中行送您最高20元话费券\",\"placeholder\":\"编辑名称，最多显示18个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":40,\"type\":\"text\",\"textMaxlength\":22,\"passItem\":false,\"w\":342,\"x\":0,\"y\":196,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"24px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaTitle\":\"true\",\"tag\":\"tg0.04688490460114725\",\"text\":\"话费+签到双重福利红包\",\"placeholder\":\"编辑文本，最多11个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":69,\"type\":\"text\",\"textMaxlength\":108,\"passItem\":false,\"textOPPOLength\":76,\"w\":280,\"x\":31,\"y\":236,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaContent\":\"true\",\"tag\":\"tg0.7916708792687688\",\"text\":\"登录手机银行首页-搜索-热门活动参加签到活动赢最高20元话费券！-测试\",\"placeholder\":\"编辑文本，最多显示54个字。编辑文本，最多显示54个字。编辑文本，最多显示54个字。\",\"locked\":true,\"event\":{}},{\"visible\":true,\"pageTitle\":\"\",\"h\":40,\"type\":\"button\",\"target\":\"\",\"passItem\":false,\"w\":202,\"x\":70,\"y\":381,\"angle\":0,\"action\":\"OPEN_APP\",\"z\":3,\"style\":{\"padding\":0,\"backgroundColor\":\"#ff9800\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"textDecoration\":\"none\",\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"fontFamily\":\"微软雅黑\",\"borderRadius\":\"32px\",\"borderWidth\":0,\"fontSize\":\"16px\",\"opacity\":1,\"borderStyle\":\"none\",\"fontWeight\":\"normal\"},\"tag\":\"tg0.6309152129863151\",\"text\":\"立即领取\",\"locked\":true,\"thirdService\":\"\",\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"maxLength\":9}]}]", "params" : [ ], "factory_info" : [ { "factory_type" : "HuaWei", "state" : 1, "version" : null }, { "factory_type" : "XiaoMi", "state" : 1, "version" : null }, { "factory_type" : "OPPO", "state" : 1, "version" : null } ] } ], "page_info" : { "offset" : 0, "limit" : 1, "total" : 10 } }

响应参数 状态码： 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字段对接。

URI GET /v1/aim/templates 表1 Query参数 参数 是否必选 参数类型 描述 tpl_id 否 String 智能信息模板ID。 最小长度：0 最大长度：36 tpl_name 否 String 智能信息模板名称。 最小长度：0 最大长度：100 tpl_type 否 String 模板分类。 public：查公共模板 private：查个人模板 说明： 不传查全部模板。 factory_type 否 Array of strings 厂商类型。 HUAWEI：华为 XI AOM I：小米 OPPO：OPPO MEIZU：魅族 VIVO：VIVO SAMSUNG：三星 数组长度：0 - 6 has_param 否 Boolean 模板是否携带参数。 true：是 false：否 begin_time 否 String 模板创建开始时间。样例：2019-10-12T07:20:50Z。 说明： begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 最小长度：0 最大长度：30 end_time 否 String 模板创建结束时间。样例：2019-10-12T07:20:50Z。 说明： begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 最小长度：0 最大长度：30 is_only_status 否 Boolean 响应里只返回状态信息，不返回pages和params。 false：默认值，返回全量信息 true：只返回状态信息 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 app_id String 应用ID，用于获取、修改应用的唯一标识。 最小长度：1 最大长度：50 app_name String 应用名称。 最小长度：1 最大长度：30 status String 状态。 最小长度：1 最大长度：20 枚举值： CREATED：待上线。应用暂未创建成功，请稍候 SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停 LAUNCHED：正常。应用添加成功，可以正常使用 region String 地域。 最小长度：1 最大长度：20 create_time String 创建时间，格式：yyyy-MM-dd'T'HH:mm:ss。 最小长度：1 最大长度：20 up_link_addr String 上行短信地址。 最小长度：1 最大长度：255 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

响应示例 状态码： 200 获取短信应用详情返回体。 { "status" : "LAUNCHED", "region" : "cn", "app_id" : "2353cb25-c169-4e20-adcf-3517****0f9e", "app_name" : "应用1", "up_link_addr" : "https://www.huaweicloud.com/sms/receive", "create_time" : "2023-08-07T02:21:26" }

响应示例 状态码： 200 返回信息。 { "data" : { "data" : [ { "menu_id" : "b1323ef35b8f4ee3a6767fa5b6cb4922", "company_id" : "4a607f2ce71aae6204e7ae0407ac6827", "company_name" : "我的企业名称", "pub_id" : "961b0f7d32314b5cb287fc06fe09cccc", "pub_name" : "我的服务号", "approve_state" : 1, "menu_state" : 1, "menu" : { "menu_items" : [ { "name" : "APP", "action_type" : "OPEN_APP", "content" : "imdada://fe.imdada.cn/static/redirect_to_dada.html?page=1000", "ext_msg" : { "app_id" : "10000004", "package_name" : "com.dada.mobile.shop.android", "browser_floor_url" : "" }, "sub_menu_items" : [ ] }, { "name" : "快应用", "action_type" : "OPEN_QUICK", "content" : "hap://app/app.com", "ext_msg" : { "depend_engine_ver" : "v8801", "third_service_name" : "我的服务号" }, "sub_menu_items" : [ ] }, { "name" : "菜单集合", "action_type" : "OPEN_SUBMENU", "content" : "", "ext_msg" : { }, "sub_menu_items" : [ { "name" : "URL", "action_type" : "OPEN_URL", "content" : "https://huawei.com", "ext_msg" : { "web_title" : "huawei", "open_in_browser" : "0" }, "sub_menu_items" : null }, { "name" : "电话联系", "action_type" : "CALLING", "content" : "131****0000", "ext_msg" : { }, "sub_menu_items" : null }, { "name" : "打开APP1", "action_type" : "OPEN_APP", "content" : "imdada://fe.imdada.cn/static/redirect_to_dada.html?page=1000", "ext_msg" : { "app_id" : "10000001", "package_name" : "com.dada.mobile.shop.android", "browser_floor_url" : "" }, "sub_menu_items" : null }, { "name" : "快应用跳转", "action_type" : "OPEN_QUICK", "content" : "hap://app/App888.com", "ext_msg" : { "depend_engine_ver" : "vv88801", "third_service_name" : "华为服务号08" }, "sub_menu_items" : null } ] } ] }, "oper_time" : "2022-08-09T13:12:07Z", "online_time" : null, "logo_img" : "290e1ecc91f043f08d6549ab1484cccc", "logo_url" : "AimSauploadService/1c6c742ca1ff485783a377339deb1437image.jpg" } ], "page_info" : { "offset" : 0, "limit" : 1, "total" : 3 } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data ListMenusRsp object 查询智能信息服务号菜单响应体。 表4 ListMenusRsp 参数 参数类型 描述 data Array of MenusRsp objects 菜单信息。 数组长度：1 - 100 page_info PageOffSet object 分页信息。 表5 MenusRsp 参数 参数类型 描述 menu_id String 菜单ID。 pub_id String 服务号ID。 pub_name String 服务号名称。 logo_img String LOGO图片资源ID。 logo_url String LOGO图片资源URL。 menu Menus object 菜单配置。 menu_state Integer 资源状态。 1：未生效 2：已生效 3：已失效 4：已冻结 approve_state Integer 审核状态。 1：待审核 2：通过 3：驳回 online_time String 上线时间。格式为：2020-12-12T12:00:00Z。 oper_time String 最新操作时间。格式为：2020-12-12T12:00:00Z。 company_id String 企业ID。 company_name String 企业名称。 表6 Menus 参数 参数类型 描述 menu_items Array of MenuItem objects 各子菜单项配置。 数组长度：0 - 3 表7 MenuItem 参数 参数类型 描述 name String 子菜单名称。 一级菜单名长度和菜单数量有关，具体约束为： 当菜单数量为1个时，菜单名长度范围在1-24个字符。 当菜单数量为2个时，菜单名长度范围在1-12个字符。 当菜单数量为3个时，菜单名长度范围在1-8个字符。 二级菜单名长度范围恒为1-16个字符。 说明： 以上字符区分中英文，一个中文占2个字符，字母和数字占1个字符，且同时生效的一组菜单内名称不能重复。 action_type String 菜单动作类型。 OPEN_SUBMENU：打开子菜单 OPEN_URL：打开URL CALLING：拨打电话 OPEN_APP：打开APP OPEN_QUICK：打开快应用 最小长度：0 最大长度：30 content String 对应值类型。对应不同action_type值，content含义如下： action_type=OPEN_SUBMENU：不填 action_type=OPEN_URL：参数数值为跳转URL action_type=CALLING：参数数值为电话号码 action_type=OPEN_APP：参数数值为APP的跳转deeplink action_type=OPEN_QUICK：参数数值为快应用跳转的deeplink 最小长度：0 最大长度：1000 ext_msg ExtMsg object 额外需要携带的信息。 action_type=OPEN_SUBMENU时，不填 action_type=CALLING时，不填 action_type=OPEN_URL时，必填 action_type=OPEN_APP时，必填 action_type=OPEN_QUICK时，必填 sub_menu_items Array of MenuItem objects 子菜单配置项。 说明： 仅当action_type=OPEN_SUBMENU时生效，且该项内不允许再配置子菜单。 数组长度：0 - 5 表8 ExtMsg 参数 参数类型 描述 open_in_browser String 打开方式。 0：webView打开 1：浏览器打开 说明： action_type=OPEN_URL必填，其他不填。 web_title String 标题，必填，长度范围为1-20个字符。 说明： action_type=OPEN_URL必填，其他不填。 package_name String app包名，长度范围为1-50个字符。 说明： action_type=OPEN_APP必填，其他不填。 app_id String 商家应用的appid，长度范围为0-60个字符。 说明： action_type=OPEN_APP必填，其他不填。 browser_floor_url String 兜底url，长度范围为0-1000个字符，支持http/https。 说明： action_type=OPEN_APP选填，其他不填。 depend_engine_ver String 依赖的快应用引擎版本号，长度范围为1-50个字符。 说明： action_type=OPEN_QUICK必填，其他不填。 third_service_name String 第三方服务名，长度范围为1-50个字符。 说明： action_type=OPEN_QUICK或OPEN_APP必填，其他不填。 表9 PageOffSet 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总量。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

URI GET /v1/aim-sa/menus 表1 Query参数 参数 是否必选 参数类型 描述 menu_id 否 String 菜单ID。 最小长度：0 最大长度：32 pub_id 否 String 服务号ID。 最小长度：0 最大长度：32 pub_name 否 String 服务号名称。 最小长度：0 最大长度：50 online_begin_time 否 String 上线开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ。 online_end_time 否 String 上线结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ。 state 否 Integer 菜单状态。 1：未生效 2：已生效 3：已失效 4：服务号已冻结 最小值：1 最大值：4 menu_name 否 String 一级菜单名称。 最小长度：0 最大长度：50 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：2147483647 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：10

请求示例 创建一个名称为"模板测试AA"，类型为通知类的短信模板。 https://koomessage.myhuaweicloud.cn/v1/sms/templates { "signature_id" : "65ba0c56-aa84-4e68-86a7-38af62c50707", "template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ", "template_desc" : "模板测试", "template_name" : "模板测试AA", "template_type" : "NOTIFY_TYPE", "universal_template" : 0, "variable_attributes" : [ { "variable_index" : 1, "variable_type" : "NEWTEXT", "variable_desc" : "直发" } ] }