huawei-cloud-api-definitions-KooMessage 0.1.20240404

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"AimSaErrorMsg":{"properties":{"error_code":{"description":"错误码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}},"ExtMsg":{"properties":{"app_id":{"description":"商家应用的appid,长度范围为0-60个字符。\n> action_type=OPEN_APP必填,其他不填。\n","type":"string"},"browser_floor_url":{"description":"兜底url,长度范围为0-1000个字符,支持http/https。\n> action_type=OPEN_APP选填,其他不填。\n","type":"string"},"depend_engine_ver":{"description":"依赖的快应用引擎版本号,长度范围为1-50个字符。\n> action_type=OPEN_QUICK必填,其他不填。\n","type":"string"},"open_in_browser":{"description":"打开方式。\n- 0:webView打开 \n- 1:浏览器打开 \n\n> action_type=OPEN_URL必填,其他不填。\n","type":"string"},"package_name":{"description":"app包名,长度范围为1-50个字符。\n> action_type=OPEN_APP必填,其他不填。\n","type":"string"},"third_service_name":{"description":"第三方服务名,长度范围为1-50个字符。\n> action_type=OPEN_QUICK或OPEN_APP必填,其他不填。\n","type":"string"},"web_title":{"description":"标题,必填,长度范围为1-20个字符。\n> action_type=OPEN_URL必填,其他不填。\n","type":"string"}}},"ListMenusResponseModel":{"description":"查询菜单返回体。","properties":{"data":{"description":"菜单信息。","items":{"$ref":"#/definitions/MenusRsp"},"maxItems":100,"minItems":1,"type":"array"},"page_info":{"$ref":"#/definitions/PageOffSet","description":"分页信息。"}}},"ListMenusRsp":{"description":"查询菜单返回体。","properties":{"data":{"$ref":"#/definitions/ListMenusResponseModel"}}},"MenuItem":{"properties":{"action_type":{"description":"菜单动作类型。\n- OPEN_SUBMENU:打开子菜单\n- OPEN_URL:打开URL\n- CALLING:拨打电话\n- OPEN_APP:打开APP\n- OPEN_QUICK:打开快应用\n","example":"OPEN_URL","maxLength":30,"minLength":0,"type":"string"},"content":{"description":"对应值类型。对应不同action_type值,content含义如下:\n- action_type=OPEN_SUBMENU:不填\n- action_type=OPEN_URL:参数数值为跳转URL\n- action_type=CALLING:参数数值为电话号码\n- action_type=OPEN_APP:参数数值为APP的跳转deeplink\n- action_type=OPEN_QUICK:参数数值为快应用跳转的deeplink\n","example":"https://www.xxxx.com","maxLength":1000,"minLength":0,"type":"string"},"ext_msg":{"$ref":"#/definitions/ExtMsg","description":"额外需要携带的信息。\n\n- action_type=OPEN_SUBMENU时,不填\n- action_type=CALLING时,不填\n- action_type=OPEN_URL时,必填\n- action_type=OPEN_APP时,必填\n- action_type=OPEN_QUICK时,必填\n"},"name":{"description":"子菜单名称。\n\n1. 一级菜单名长度和菜单数量有关,具体约束为:\n\n   - 当菜单数量为1个时,菜单名长度范围在1-24个字符。\n   - 当菜单数量为2个时,菜单名长度范围在1-12个字符。\n   - 当菜单数量为3个时,菜单名长度范围在1-8个字符。\n\n2. 二级菜单名长度范围恒为1-16个字符。\n\n> 以上字符区分中英文,一个中文占2个字符,字母和数字占1个字符,且同时生效的一组菜单内名称不能重复。","type":"string"},"sub_menu_items":{"description":"子菜单配置项。\n\n> 仅当action_type=OPEN_SUBMENU时生效,且该项内不允许再配置子菜单。\n","example":"[]","items":{"$ref":"#/definitions/MenuItem"},"maxItems":5,"minItems":0,"type":"array"}},"required":["action_type","name"]},"Menus":{"properties":{"menu_items":{"description":"各子菜单项配置。\n","items":{"$ref":"#/definitions/MenuItem"},"maxItems":3,"minItems":0,"type":"array"}},"required":["menu_items"]},"MenusRsp":{"properties":{"approve_state":{"description":"审核状态。\n- 1:待审核 \n- 2:通过 \n- 3:驳回\n\n","type":"integer"},"logo_img":{"description":"LOGO图片资源ID。","type":"string"},"logo_url":{"description":"LOGO图片资源URL。","type":"string"},"menu":{"$ref":"#/definitions/Menus","description":"菜单配置。"},"menu_id":{"description":"菜单ID。","type":"string"},"menu_state":{"description":"资源状态。 \n- 1:未生效\n- 2:已生效\n- 3:已失效 \n- 4:已冻结\n\n","type":"integer"},"online_time":{"description":"上线时间。格式为:2020-12-12T12:00:00Z。","type":"string"},"oper_time":{"description":"最新操作时间。格式为:2020-12-12T12:00:00Z。","type":"string"},"pub_id":{"description":"服务号ID。","type":"string"},"pub_name":{"description":"服务号名称。","type":"string"}}},"PageOffSet":{"properties":{"limit":{"description":"每页显示的条目数量。","type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","type":"integer"},"total":{"description":"总量。","type":"integer"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"768b53cbfb1148a29bc9b81fb477a6f5","info_version":"v1","method":"get","name":"ListMenus","parameters":{},"paths":{"/v1/aim-sa/menus":{"get":{"consumes":["application/json"],"description":"根据用户提供的过滤条件查询服务号菜单。","operationId":"ListMenus","parameters":[{"description":"菜单ID。","in":"query","maxLength":32,"minLength":0,"name":"menu_id","required":false,"type":"string"},{"description":"服务号ID。","in":"query","maxLength":32,"minLength":0,"name":"pub_id","required":false,"type":"string"},{"description":"服务号名称。","in":"query","maxLength":50,"minLength":0,"name":"pub_name","required":false,"type":"string"},{"description":"上线开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ。","in":"query","name":"online_begin_time","pattern":"yyyy-MM-ddTHH:mm:ssZ","required":false,"type":"string"},{"description":"上线结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ。","in":"query","name":"online_end_time","pattern":"yyyy-MM-ddTHH:mm:ssZ","required":false,"type":"string"},{"description":"菜单状态。 \n- 1:未生效 \n- 2:已生效 \n- 3:已失效 \n- 4:服务号已冻结\n","in":"query","maximum":4,"minimum":1,"name":"state","required":false,"type":"integer"},{"description":"一级菜单名称。","in":"query","maxLength":50,"minLength":0,"name":"menu_name","required":false,"type":"string"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"每页显示的条目数量。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"data":{"data":[{"approve_state":1,"create_time":"2022-08-09T13:12:07Z","logo_img":"290e1ecc91f043f08d6549ab1484cccc","logo_url":"AimSauploadService/1c6c742ca1ff485783a377339deb1437image.jpg","menu":{"custom_menus":[],"menu_items":[{"action_type":"OPEN_APP","content":"imdada://fe.imdada.cn/static/redirect_to_dada.html?page=1000","ext_msg":{"app_id":"10000004","browser_floor_url":"","package_name":"com.dada.mobile.shop.android"},"name":"APP","sub_menu_items":[]},{"action_type":"OPEN_QUICK","content":"hap://app/app.com","ext_msg":{"depend_engine_ver":"v8801","third_service_name":"我的服务号"},"name":"快应用","sub_menu_items":[]},{"action_type":"OPEN_SUBMENU","content":"","ext_msg":{},"name":"菜单集合","sub_menu_items":[{"action_type":"OPEN_URL","content":"https://huawei.com","ext_msg":{"open_in_browser":"0","web_title":"huawei"},"name":"URL"},{"action_type":"CALLING","content":"131****0000","ext_msg":{},"name":"电话联系"},{"action_type":"OPEN_APP","content":"imdada://fe.imdada.cn/static/redirect_to_dada.html?page=1000","ext_msg":{"app_id":"10000001","browser_floor_url":"","package_name":"com.dada.mobile.shop.android"},"name":"打开APP1"},{"action_type":"OPEN_QUICK","content":"hap://app/App888.com","ext_msg":{"depend_engine_ver":"vv88801","third_service_name":"华为服务号08"},"name":"快应用跳转"}]}]},"menu_id":"b1323ef35b8f4ee3a6767fa5b6cb4922","menu_name":"菜单集合","menu_state":1,"oper_time":"2022-08-09T13:12:07Z","pub_id":"961b0f7d32314b5cb287fc06fe09cccc","pub_name":"我的服务号"}],"page_info":{"limit":1,"offset":0,"total":3}}}},"schema":{"$ref":"#/definitions/ListMenusRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}}},"security":[{"apig-auth-iam":[]}],"summary":"查询智能信息服务号菜单","tags":["AimSaMenu"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-request-examples-description-1":"查询菜单","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/menus?limit=1","x-support-sdk":"Y"}}},"product_short":"KooMessage","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"查询智能信息服务号菜单","tags":"智能信息服务号菜单","uri":null,"version":"2.0"}