云服务器内容精选

  • 请求示例 根据主页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" } ] }
  • 响应参数 状态码: 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": "快应用 LOG O图片资源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 结果详情。
  • 响应示例 状态码: 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 } } }
  • 请求参数 表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个字符。
  • 响应示例 状态码: 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
  • URI GET /v1/aim-sa/pubs 表1 Query参数 参数 是否必选 参数类型 描述 pub_name 否 String 服务号名称。 最小长度:1 最大长度:15 state 否 Integer 服务号状态。 1:未生效 2:已生效 3:已失效 4:已冻结 最小值:1 最大值:4 start_time 否 String 开始上线时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:214748364 缺省值:0 limit 否 Integer 每页显示的条目数量。 最小值:1 最大值:100 缺省值:10 end_time 否 String 结束上线时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 industry 否 String 服务号所属行业。 1:金融理财 2:社交通讯 3:影音娱乐 4:旅游出行 5:购物 6:本地生活 7:运动健康 8:教育培训 9:新闻阅读 10:运营商 11:其他 最小值:1 最大值:11 approve_state 否 Integer 审核状态。 1:审核中 2:审核通过 3:驳回
  • 响应示例 状态码: 200 返回信息。 { "page_info" : { "offset" : 0, "limit" : 1, "total" : 143 }, "data" : [ { "pub_id" : "9405df1846a348e0b997d855bf80acc7", "company_id" : "6b3dd34b00e94326908720fa97f2b132", "pub_remark" : "K歌", "oper_time" : "2022-06-01T15:03:36Z", "state" : 1, "approve_state" : 3, "online_time" : "2022-06-07T14:08:09Z", "company_name" : null, "pub_name" : "轰趴馆-K歌", "logo_img" : "ab44b435b7a442a59e199735a9e3ce26", "logo_url" : "AimSauploadService/1dc408cff6b147a690f19732a42731273.png", "authorization_files" : { "63e2a3d465744bf69cf0321bd3e9bfb2" : "AimSauploadService/75356fb37c5b4067ba691ea2026ec69e3.png" }, "auto_get_port" : 1, "industry" : 1, "pub_abstract" : "我来一首天籁吧", "signs_for_auto_get_port" : [ "轰趴馆" ], "areas_for_auto_get_port" : [ "陕西省", "佛山市" ] } ] }
  • 请求示例 注册智能信息服务号通道号。设置通道号为"8822053111111",普通类型,不校验签名。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports { "port" : "8822053111111", "sign" : [ "华为云 KooMessage " ], "port_type" : 1, "sign_check" : 0, "authorization_files" : [ "3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png" ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 String 通道号。 port_type=5时 ,长度必须为5 port_type=1或3,长度在21位内 最小长度:0 最大长度:21 port_type 是 Integer 通道号类型。 1:普通 3:前缀号段 5:后缀号段 最小值:1 最大值:5 sign 是 Array of strings 签名列表,最大长度为5。单个签名长度为2-18。 最小长度:2 最大长度:18 数组长度:0 - 5 sign_check 是 Integer 是否需要校验。 0:不校验 1:校验签名 说明: 当port_type为3或者5时,sign_check必须为1。 最小值:0 最大值:1 authorization_files 是 Array of strings 授权证明图片资源,支持jpg、bmp、png和jpeg格式,全部图片总大小不超过4M,最多支持5张。参数格式为:资源ID:资源URL,样例:3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png。 说明: 资源ID与资源URL对应上传智能信息服务号图片资源API返回的resource_id和resource_url。 数组长度:0 - 5
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data PortRegisterResponse object 注册通道号响应体。 表4 PortRegisterResponse 参数 参数类型 描述 data RegisterResult object 返回体。 表5 RegisterResult 参数 参数类型 描述 port String 通道号。 port_type Integer 通道号类型。 1:普通 3:前缀号段 5:后缀号段 sign Array of strings 签名列表,最大长度为5。 数组长度:0 - 5 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。
  • 请求示例 根据菜单ID修改智能信息服务号菜单。设置修改原因为"业务调整",修改或添加菜单。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/menus/34cffce987e64757bb9b711895714692 { "change_reason" : "业务调整", "menu" : { "menu_items" : [ { "action_type" : "OPEN_APP", "name" : "通过申请", "content" : "hap://app/xxxx.deeplink.xxxxx", "ext_msg" : { "package_name" : "baoming", "app_id" : "", "browser_floor_url" : "https://www.example.com/" } }, { "action_type" : "OPEN_URL", "name" : "打开链接", "content" : "https://www.example.com/", "ext_msg" : { "web_title" : "搜索", "open_in_browser" : "1" } }, { "action_type" : "OPEN_SUBMENU", "name" : "通过菜单", "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" } }, { "action_type" : "CALLING", "name" : "电一下", "sub_menu_items" : [ ], "content" : "131****0000" }, { "action_type" : "OPEN_APP", "name" : "手机软件", "sub_menu_items" : [ ], "content" : "hap://app/xxxx.deeplink.xxxxx", "ext_msg" : { "package_name" : "开心消消乐", "app_id" : "appid", "browser_floor_url" : "https://www.example.com/" } }, { "action_type" : "OPEN_QUICK", "name" : "快应用", "sub_menu_items" : [ ], "content" : "hap://app/11111111111", "ext_msg" : { "depend_engine_ver" : "快应用引擎", "third_service_name" : "服务名" } }, { "action_type" : "OPEN_QUICK", "name" : "快应用", "sub_menu_items" : [ ], "content" : "hap://app/dfs/dfdf", "ext_msg" : { "depend_engine_ver" : "v1.1.0", "third_service_name" : "测试" } } ] } ] } }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 data UpdateMenuRsp object 修改智能信息服务号菜单响应体。 表8 UpdateMenuRsp 参数 参数类型 描述 menu_id String 菜单ID。 log_id String 操作记录ID。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 menu 是 Menus object 菜单配置信息。 change_reason 是 String 修改原因。 最小长度:1 最大长度:1000 表4 Menus 参数 是否必选 参数类型 描述 menu_items 是 Array of MenuItem objects 各子菜单项配置。 数组长度:0 - 3 表5 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 表6 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必填,其他不填。