huawei-cloud-api-definitions-KooMessage 0.1.20240202

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"}}},"PortalModel":{"description":"主页模型。","properties":{"approve_state":{"description":"审核状态。 \n- 1:待审核 \n- 2:通过 \n- 3:驳回\n","format":"int32","type":"integer"},"background_img":{"description":"主页背景图片资源ID。","type":"string"},"background_img_url":{"description":"背景图片URL。","type":"string"},"change_reason":{"description":"修改原因。","type":"string"},"company_id":{"description":"企业ID。","type":"string"},"company_name":{"description":"企业名称。","type":"string"},"create_time":{"description":"创建时间。","format":"date-time","type":"string"},"creator":{"description":"创建人。","type":"string"},"fastapps":{"description":"快应用列表。\n\n> 以JSON列表返回,格式: > {\"name\": \"快应用名称\",\"logo_img\": \"快应用LOGO图片资源ID\", \"logo_img_url\": \"快应用LOGO图片资源URL\", \"description\": \"快应用描述\",\"deeplink\": \"hap://app/fastapp\",\"depend_engine_version\": \"1040\"}。\n","type":"string"},"online_time":{"description":"上线时间。","format":"date-time","type":"string"},"portal_id":{"description":"主页ID。","type":"string"},"pub_id":{"description":"服务号ID。","type":"string"},"pub_name":{"description":"服务号名称。","type":"string"},"state":{"description":"资源状态。 \n- 1:未生效 \n- 2:已生效 \n- 3:已失效 \n- 4:已冻结\n","format":"int32","type":"integer"},"summary":{"description":"简介。","type":"string"},"tels":{"description":"热线号列表。\n\n> 以JSON列表返回,格式:\n> {\"tel\": \"400-800-8800\", \"usage\": \"官方服务电话\"}。\n","type":"string"}},"required":["approve_state","background_img","change_reason","company_name","create_time","creator","fastapps","online_time","portal_id","pub_id","pub_name","state","summary","tels"]},"TelModel":{"description":"热线模型。","properties":{"tel":{"description":"电话号码(只能包含数字和”-“,且开头和结尾必须为数字)。","maxLength":20,"minLength":1,"pattern":"^[0-9]+[\\-]?[0-9]+$","type":"string"},"usage":{"description":"号码用途。\n\n> 号码用途长度范围为1-30个字符,中文占2个字符,英文占1个字符。\n","type":"string"}},"required":["tel","usage"]},"UpdatePortalFastappModel":{"description":"快应用模型。","properties":{"deeplink":{"description":"快应用跳转链接。","maxLength":1000,"minLength":1,"pattern":"^hap://app/.*$","type":"string"},"depend_engine_version":{"description":"快应用依赖引擎版本。\n\n> 长度范围为1-50个字符,中文占2个字符,英文占1个字符。\n","type":"string"},"description":{"description":"快应用描述。\n\n> 长度范围为1-38个字符,中文占2个字符,英文占1个字符。\n","type":"string"},"logo_img":{"description":"快应用LOGO图片资源ID。\n\n> 图片格式为jpg、bmp、jpeg,分辨率大于等于192*192,大小不超过4M。参数值为上传智能信息服务号图片资源API返回的resource_id。\n","maxLength":32,"minLength":32,"type":"string"},"name":{"description":"快应用名。\n\n> 长度范围为1-30个字符,中文占2个字符,英文占1个字符。\n","pattern":"^((?![\\s\\*\\-]).){1,15}$","type":"string"}}},"UpdatePortalInfoRequestBody":{"description":"更新主页请求体。","example":{"background_img":"2f808aeae54f42b6b60f354d076bb63b","change_reason":"更新主页","fastapps":[{"deeplink":"hap://app/fastapp1","depend_engine_version":"1040","description":"快应用简介。","logo_img":"d1e9d4955b08458b9d5abc228e08b164","name":"快应用名称"}],"summary":"主页简介","tels":[{"tel":"14325352232","usage":"用途"}]},"properties":{"background_img":{"description":"主页背景图片资源ID。\n>\n分辨率大于等于1440*810,支持jpg、jpeg、bmp、png。参数值为上传智能信息服务号图片资源API返回的resource_id。\n","maxLength":32,"minLength":32,"type":"string"},"change_reason":{"description":"修改原因。","maxLength":50,"minLength":5,"type":"string"},"fastapps":{"description":"快应用列表。","items":{"$ref":"#/definitions/UpdatePortalFastappModel"},"maxItems":10,"minItems":0,"type":"array"},"hw_pubs":{"description":"华为服务号列表。\n\n> 预留,暂未使用。\n","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"summary":{"description":"简介。","maxLength":75,"minLength":1,"type":"string"},"tels":{"description":"热线号列表。","items":{"$ref":"#/definitions/TelModel"},"maxItems":5,"minItems":0,"type":"array"}},"required":["change_reason","background_img","summary"]},"UpdatePortalInfoResponseModel":{"description":"更新主页响应体。","properties":{"portal":{"$ref":"#/definitions/PortalModel","description":"主页信息。"}}},"UpdatePortalInfoRsp":{"properties":{"data":{"$ref":"#/definitions/UpdatePortalInfoResponseModel"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"3fb51e32e7e14cfa985c7356389444d7","info_version":"v1","method":"put","name":"UpdatePortalInfo","parameters":{},"paths":{"/v1/aim-sa/portals/{portal_id}":{"put":{"consumes":["application/json"],"description":"\n用户对已创建的主页进行信息的修改。","operationId":"UpdatePortalInfo","parameters":[{"description":"主页ID。","in":"path","maxLength":32,"minLength":32,"name":"portal_id","required":true,"type":"string"},{"description":"更新主页请求结构体。","in":"body","name":"UpdatePortalRequestBody","required":true,"schema":{"$ref":"#/definitions/UpdatePortalInfoRequestBody"}},{"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":{"portal":{"approve_state":1,"background_img":"1d191b06da9a485895e10e48cbc5cccc","background_img_url":"AimSauploadService/ad63cdaa3a044a589bbde7f6a4551111.png","change_reason":"我想修改主页","company_id":"cf2d298c555e44bf9fafdf5ada0ccccc","company_name":"南派餐饮","create_time":"2022-08-08T01:49:29Z","creator":"7139bc07d53240dca88722930485cccc","fastapps":"[{\"name\":\"酷玩\",\"logo_img\":\"d2fe995119584f88be9e9ef53d2ccccc\",\"logo_img_url\":\"AimSauploadService/ccccd328eba84b27ab215122aada398ftest22_192x192 (1).jpg\",\"description\":\"这是一个快应用的描述\",\"deeplink\":\"hap://app/122\",\"depend_engine_version\":\"1\"}]","portal_id":"bcce7e60df6445a592c09ca95dfdcccc","pub_id":"961b0f7d32314b5cb287fc06fe09cccc","pub_name":"服务号名称","state":1,"summary":"测试-欢迎来到酷玩影视","tels":"[{\"usage\":\"加入我们\",\"tel\":\"131****0000\"},{\"usage\":\"联系我们\",\"tel\":\"131****0001\"}]"}}}},"schema":{"$ref":"#/definitions/UpdatePortalInfoRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}}},"security":[{"apig-auth-iam":[]}],"summary":"修改主页信息","tags":["AimSaPortal"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-opseverity":"Info","x-request-examples-1":{"background_img":"1d191b06da9a485895e10e48cbc5cccc","change_reason":"我想修改主页","fastapps":[{"deeplink":"hap://app/122","depend_engine_version":"1","description":"这是一个快应用的描述","index":0,"logo_img":"d2fe995119584f88be9e9ef53d2ccccc","name":"酷玩"}],"pub_id":"961b0f7d32314b5cb287fc06fe09cccc","summary":"测试-欢迎来到酷玩影视","tels":[{"tel":"131****0000","usage":"加入我们"},{"tel":"131****0001","usage":"联系我们"}]},"x-request-examples-description-1":"根据主页ID修改主页信息。设置修改原因为\"我想修改主页\",修改主页背景图片资源ID为\"1d191b06da9a485895e10e48cbc5cccc\",快应用跳转地址为\"hap://app/122\"。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.com/v1/aim-sa/portals/bcce7e60df6445a592c09ca95dfdcccc","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"}