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":{"AIMTemplate":{"description":"短信下发响应对象。","properties":{"audit_desc":{"description":"审批信息。","example":"同意使用","type":"string"},"audit_state":{"description":"审核状态。\n- 0:未提交 \n- 1:审核中 \n- 2:审核通过 \n- 3:审核失败\n","type":"integer"},"creation_time":{"description":"创建时间。样例为:1970-01-01T00:00:00Z。","example":"1970-01-01T00:00:00Z","type":"string"},"description":{"description":"短信示例。\n\n>对应创建个人模板API中的入参sms_example。\n","example":"【智能信息】尊敬的用户您好","type":"string"},"disable_desc":{"description":"禁用原因。","example":"停止使用","type":"string"},"disable_time":{"description":"禁用时间。样例:1970-01-01T00:00 :00Z。","example":"1970-01-01T00:00:00Z","type":"string"},"factory_info":{"description":"支持厂商列表。","items":{"$ref":"#/definitions/FactoryInfo"},"type":"array"},"pages":{"description":"模板页面HTML,JSON格式。","type":"string"},"params":{"description":"模板动态参数列表。","items":{"$ref":"#/definitions/AIMTemplateParams"},"type":"array"},"scene":{"description":"场景类型。\n","example":"活动促销","type":"string"},"tpl_id":{"description":"智能信息模板ID。\n\n> 智能信息平台生成的模板ID,由9位数字组成。\n","example":"100001000","type":"string"},"tpl_name":{"description":"智能信息模板名称。","example":"618 活动促销模板","type":"string"},"tpl_state":{"description":"模板状态。 \n- 0:禁用\n- 1:启用\n","type":"integer"},"update_time":{"description":"更新时间。样例为:1970-01-01T00:00:00Z。","example":"1970-01-01T00:00:00Z","type":"string"}}},"AIMTemplateList":{"description":"查询模板返回体。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"templates":{"description":"模板列表。","items":{"$ref":"#/definitions/AIMTemplate"},"type":"array"}}},"AIMTemplateParams":{"description":"模板参数。","properties":{"fix_length":{"description":"固定长度。","type":"integer"},"has_length":{"description":"动态参数是否长度限制。\n- false:不可设置 \n- true:可设置\n","example":true,"type":"boolean"},"length_restrict":{"description":"长度限制。","type":"boolean"},"max_length":{"description":"最大长度。","type":"integer"},"min_length":{"description":"最小长度。","type":"integer"},"name":{"description":"参数名称。","example":"param2","type":"string"},"type":{"description":"参数类型。\n- string:文本\n- integer:数字\n","example":"string","type":"string"}}},"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"FactoryInfo":{"description":"各终端厂商的审核状态。","properties":{"factory_type":{"description":"厂商类型。\n\n- HUAWEI:表示华为厂商\n- XIAOMI:表示小米厂商\n- OPPO:表示OPPO厂商\n- VIVO:表示VIVO厂商\n- MEIZU:表示魅族厂商\n- SAMSUNG:表示三星厂商\n","type":"string"},"state":{"description":"模板状态。\n\n- 1:激活 \n- 其他:未激活\n","type":"integer"},"version":{"description":"厂商版本","type":"string"}},"required":["factory_type","state"]},"Page":{"description":"分页信息。","properties":{"limit":{"description":"每页显示的条目数量。","example":20,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","example":1,"type":"integer"},"total":{"description":"总条数。","example":222,"type":"integer"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"9927b3ad474c4dc88a0645690dec50b2","info_version":"v1","method":"get","name":"ListAimTemplates","parameters":{},"paths":{"/v1/aim/templates":{"get":{"consumes":["application/json"],"deprecated":false,"description":"\n根据客户提供的过滤条件查询智能信息模板列表。\n\n","operationId":"ListAimTemplates","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"智能信息模板ID。","in":"query","maxLength":36,"minLength":0,"name":"tpl_id","required":false,"type":"string"},{"description":"智能信息模板名称。","in":"query","maxLength":100,"minLength":0,"name":"tpl_name","required":false,"type":"string"},{"description":"模板分类。\n\n- public:查公共模板\n- private:查个人模板\n\n> 不传查全部模板。\n","in":"query","name":"tpl_type","required":false,"type":"string"},{"description":"厂商类型。\n- HUAWEI:华为\n- XIAOMI:小米\n- OPPO:OPPO\n- MEIZU:魅族\n- VIVO:VIVO\n","in":"query","items":{"type":"string"},"maxItems":5,"minItems":0,"name":"factory_type","required":false,"type":"array"},{"description":"模板是否携带参数。\n\n- true:是\n- false:否\n","in":"query","name":"has_param","required":false,"type":"boolean"},{"description":"模板创建开始时间。样例:2019-10-12T07:20:50Z。\n\n> begin_time和end_time必须全部为空或全部不为空,并且begin_time不能大于end_time。\n","in":"query","maxLength":30,"minLength":0,"name":"begin_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"模板创建结束时间。样例:2019-10-12T07:20:50Z。\n\n> begin_time和end_time必须全部为空或全部不为空,并且begin_time不能大于end_time。\n","in":"query","maxLength":30,"minLength":0,"name":"end_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"响应里只返回状态信息,不返回pages和params。\n\n- false:默认值,返回全量信息\n- true:只返回状态信息\n","in":"query","name":"is_only_status","required":false,"type":"boolean"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。\n","in":"query","maximum":1000000,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":20,"description":"每页显示的条目数量。\n","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"audit_desc":"审核通过","audit_state":2,"creation_time":"2022-05-23T17:49:00Z","description":"您有一条新消息,测试。","disable_desc":"","disable_time":"1970-01-01T00:00:00Z","factory_info":[{"factory_type":"HuaWei","state":1,"version":null},{"factory_type":"XiaoMi","state":1,"version":null},{"factory_type":"OPPO","state":1,"version":null}],"pages":"[{\"typeIndex\":0,\"cardId\":\"com.hbm.redpacket\",\"style\":{\"width\":\"342px\",\"opacity\":1,\"height\":\"456px\"},\"label\":\"主页1\",\"tag\":\"page1\",\"content\":[{\"visible\":true,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg.png\",\"h\":456,\"isBgimg\":true,\"type\":\"image\",\"skipReplaceSrc\":true,\"size\":0,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":0,\"notValid\":true,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.34403423289983026\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"\",\"longitude\":\"\"}},{\"serviceType\":0,\"visible\":false,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/defaultImg/defaultImg2.jpg\",\"h\":23,\"type\":\"serviceNumber\",\"serviceName\":\"请选择服务号\",\"skipReplaceSrc\":true,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":348,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"color\":\"#fff\",\"textAlign\":\"center\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.6574206986442455\",\"locked\":true,\"serviceID\":\"\"},{\"visible\":true,\"proportion\":[1,1],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/603264561/20220523174859881fILNZn.jpg\",\"bg\":{\"proportion\":[9,5],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/610579108/20220523174900022c8XeYT.jpg\",\"w\":342,\"h\":190},\"h\":70,\"type\":\"image\",\"oppobg\":{\"proportion\":[3,4],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg-oppo.jpg\",\"w\":342,\"h\":456},\"passItem\":false,\"size\":91289,\"borderRadius\":0,\"w\":70,\"x\":136,\"width\":1024,\"y\":44,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":\"70px\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.45509392249988934\",\"srcParam\":\"\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"latitude\":\"\",\"navType\":2,\"floorType\":0,\"description\":\"\",\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"browserFloorUrl\":\"\",\"merchantName\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"isBg\":0,\"height\":1024},{\"visible\":true,\"h\":23,\"title\":\"true\",\"type\":\"text\",\"textMaxlength\":36,\"passItem\":false,\"textOPPOLength\":24,\"w\":342,\"x\":0,\"y\":128,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"tag\":\"tg0.42763825585357296\",\"text\":\"中行送您最高20元话费券\",\"placeholder\":\"编辑名称,最多显示18个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":40,\"type\":\"text\",\"textMaxlength\":22,\"passItem\":false,\"w\":342,\"x\":0,\"y\":196,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"24px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaTitle\":\"true\",\"tag\":\"tg0.04688490460114725\",\"text\":\"话费+签到双重福利红包\",\"placeholder\":\"编辑文本,最多11个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":69,\"type\":\"text\",\"textMaxlength\":108,\"passItem\":false,\"textOPPOLength\":76,\"w\":280,\"x\":31,\"y\":236,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaContent\":\"true\",\"tag\":\"tg0.7916708792687688\",\"text\":\"登录手机银行首页-搜索-热门活动参加签到活动赢最高20元话费券!-测试\",\"placeholder\":\"编辑文本,最多显示54个字。编辑文本,最多显示54个字。编辑文本,最多显示54个字。\",\"locked\":true,\"event\":{}},{\"visible\":true,\"pageTitle\":\"\",\"h\":40,\"type\":\"button\",\"target\":\"\",\"passItem\":false,\"w\":202,\"x\":70,\"y\":381,\"angle\":0,\"action\":\"OPEN_APP\",\"z\":3,\"style\":{\"padding\":0,\"backgroundColor\":\"#ff9800\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"textDecoration\":\"none\",\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"fontFamily\":\"微软雅黑\",\"borderRadius\":\"32px\",\"borderWidth\":0,\"fontSize\":\"16px\",\"opacity\":1,\"borderStyle\":\"none\",\"fontWeight\":\"normal\"},\"tag\":\"tg0.6309152129863151\",\"text\":\"立即领取\",\"locked\":true,\"thirdService\":\"\",\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"maxLength\":9}]}]","params":[],"scene":"测试模板","tpl_id":"600000001","tpl_name":"测试-中行签到","tpl_state":1,"update_time":"2022-05-23T19:29:14Z"}},"schema":{"$ref":"#/definitions/AIMTemplateList"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"summary":"查询模板","tags":["AIMTemplate"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-opseverity":"Info","x-request-examples-description-1":"查询所有模板","x-request-examples-description-2":"根据模板ID查询模板,模板ID为\"600000001\"。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim/templates","x-request-examples-url-2":"https://koomessage.myhuaweicloud.cn/v1/aim/templates?tpl_id=600000001","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"}