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"}}},"ListPortalInfosResponseModel":{"description":"查询主页列表响应体。","properties":{"page_info":{"$ref":"#/definitions/PageOffSet","description":"分页信息。"},"portals":{"description":"主页列表。","items":{"$ref":"#/definitions/PortalModel"},"maxItems":1000,"minItems":0,"type":"array"}}},"ListPortalInfosRsp":{"properties":{"data":{"$ref":"#/definitions/ListPortalInfosResponseModel"}}},"PageOffSet":{"properties":{"limit":{"description":"每页显示的条目数量。","type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","type":"integer"},"total":{"description":"总量。","type":"integer"}}},"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"]}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"8dc29675a5584effad6a27f6672746e7","info_version":"v1","method":"get","name":"ListPortalInfos","parameters":{},"paths":{"/v1/aim-sa/portals":{"get":{"consumes":["application/json"],"description":"\n根据用户提供的过滤条件查找用户管理的主页列表。","operationId":"ListPortalInfos","parameters":[{"description":"服务号名称。","in":"query","maxLength":15,"minLength":0,"name":"pub_name","required":false,"type":"string"},{"description":"起始上线时间。格式为:yyyy-MM-ddTHH:mm:ssZ。","format":"date-time","in":"query","maxLength":50,"minLength":10,"name":"begin_time","required":false,"type":"string"},{"description":"截止上线时间。格式为:yyyy-MM-ddTHH:mm:ssZ。","format":"date-time","in":"query","maxLength":50,"minLength":10,"name":"end_time","required":false,"type":"string"},{"description":"主页状态。\n- 1:未生效 \n- 2:已生效 \n- 3:已失效 \n- 4:服务号已冻结\n","format":"int32","in":"query","name":"state","required":false,"type":"integer"},{"default":10,"description":"每页显示的条目数量。","format":"int32","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","format":"int32","in":"query","maximum":2147483647,"minimum":0,"name":"offset","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":{"data":{"page_info":{"limit":1,"offset":0,"total":6},"portals":[{"approve_state":2,"background_img":"1498ae10657d46d596697e00c72707dc","background_img_url":"AimSauploadService/4e90259caa274a3db90441d01b1c88c9456789.jpg","company_id":"cf2d298c555e44bf9fafdf5ada0cfc6f","company_name":"轰趴馆","create_time":"2022-06-02T16:16:41Z","creator":"69c4daf2ad9d4792bc40211a1d540fa1","fastapps":"[{\"name\":\"fastapp11012345\",\"logo_img\":\"10318b626df24a2ab02cfdcd659a18ec\",\"logo_img_url\":\"AimSauploadService/9d649d75258e43008ba054bdc1e80c0e20220520-175621(WeLinkPC).jpg\",\"description\":\"一二三四五六七八九零一二三四五六七八九\",\"deeplink\":\"hap://app/fastapp110\",\"depend_engine_version\":\"1040\"}]","online_time":"2022-06-02T16:26:25Z","portal_id":"71233b4208194db991e0ec091f232d5c","pub_id":"7c6df57455a6483884736d6bbec0d6e2","pub_name":"林记小铺","state":2,"summary":"通过华为云主页创建","tels":"[{\"usage\":\"usage1华为\",\"tel\":\"4000-955-988\"}]"}]}},"schema":{"$ref":"#/definitions/ListPortalInfosRsp"}},"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-description-1":"查询主页","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/portals","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"}