huawei-cloud-api-definitions-KooMessage 0.1.20260108

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"}}},"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"]},"UpdateMenuRequestBody":{"properties":{"change_reason":{"description":"修改原因。","maxLength":1000,"minLength":1,"type":"string"},"menu":{"$ref":"#/definitions/Menus","description":"菜单配置信息。"}},"required":["change_reason","menu"]},"UpdateMenuResponseModel":{"properties":{"log_id":{"description":"操作记录ID。","type":"string"},"menu_id":{"description":"菜单ID。","type":"string"}}},"UpdateMenuRsp":{"properties":{"data":{"$ref":"#/definitions/UpdateMenuResponseModel","description":"修改菜单返回体。"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"5cb9c2feccfe4aa3984e9df00ba3df84","info_version":"v1","method":"put","name":"UpdateMenu","parameters":{},"paths":{"/v1/aim-sa/menus/{menu_id}":{"put":{"consumes":["application/json"],"description":"\n支持用户修改所属企业的指定菜单。","operationId":"UpdateMenu","parameters":[{"description":"菜单ID。","in":"path","maxLength":32,"minLength":1,"name":"menu_id","required":true,"type":"string"},{"description":"修改菜单请求体。","in":"body","name":"updateMenuRequestBody","required":true,"schema":{"$ref":"#/definitions/UpdateMenuRequestBody"}},{"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":{"log_id":"6766","menu_id":"34cffce987e64757bb9b711895714692"}}},"schema":{"$ref":"#/definitions/UpdateMenuRsp"}},"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-1":{"change_reason":"业务调整","menu":{"menu_items":[{"action_type":"OPEN_APP","content":"hap://app/xxxx.deeplink.xxxxx","ext_msg":{"app_id":"","browser_floor_url":"https://www.xxxx.com/","package_name":"baoming","x_app_id":"","x_package_names":""},"name":"通过申请","sub_menu_items":[]},{"action_type":"OPEN_URL","content":"https://www.xxxx.com/","ext_msg":{"open_in_browser":"1","web_title":"搜索"},"name":"打开链接","sub_menu_items":[]},{"action_type":"OPEN_SUBMENU","ext_msg":{},"name":"通过菜单","sub_menu_items":[{"action_type":"OPEN_URL","content":"https://www.xxxx.com/","ext_msg":{"open_in_browser":"1","web_title":"url标题"},"name":"搜索一下","sub_menu_items":[]},{"action_type":"CALLING","content":"131****0000","ext_msg":{},"name":"电一下","sub_menu_items":[]},{"action_type":"OPEN_APP","content":"hap://app/xxxx.deeplink.xxxxx","ext_msg":{"app_id":"appid","browser_floor_url":"https://www.xxxx.com/","package_name":"开心消消乐","x_app_id":"xappid","x_package_names":"packagenames"},"name":"手机软件","sub_menu_items":[]},{"action_type":"OPEN_QUICK","content":"hap://app/11111111111","ext_msg":{"depend_engine_ver":"快应用引擎","third_service_name":"服务名"},"name":"快应用","sub_menu_items":[]},{"action_type":"OPEN_QUICK","content":"hap://app/dfs/dfdf","ext_msg":{"depend_engine_ver":"v1.1.0","third_service_name":"测试"},"name":"快应用","sub_menu_items":[]}]}]}},"x-request-examples-description-1":"根据菜单ID修改智能信息服务号菜单。设置修改原因为\"业务调整\",修改或添加菜单。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/menus/34cffce987e64757bb9b711895714692","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"}