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":{"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"ListResolveTaskResult":{"description":"生成短链响应实体类。","properties":{"aim_code_type":{"description":"智能信息编码类型。\n- group:群发\n- individual:个性化\n","example":"group","type":"string"},"domain":{"description":"自定义短链域名,由大小写字母和数字组成的二级域名。","example":"km2n.cn","pattern":"[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+\\.?","type":"string"},"expiration_time":{"description":"失效时间(天)。","example":7,"type":"integer"},"params":{"description":"短链列表。该列表中只会有一条短链记录,如果一个任务中生成多个短链,则需要客户端基于任务ID(task_id)自己去合并。\n\n> 建议使用查询解析明细接口查询此字段信息,未来版本有计划移除该字段。\n","items":{"$ref":"#/definitions/ListResolveTaskResultParam"},"maxItems":100,"type":"array"},"resolved_times":{"description":"实际已解析数量统计。\n","example":10000,"type":"integer"},"resolving_times":{"description":"用户创建时提交的最大解析次数。","example":10000,"type":"integer"},"sms_signs":{"description":"短信签名列表。","items":{"description":"短信签名。","example":"华为云科技","type":"string"},"type":"array"},"task_id":{"description":"任务ID。","example":"e5f475be-f30e-4e5d-85dc-8bd8ea88111b","type":"string"},"task_name":{"description":"任务名称。","example":"ZF2","type":"string"},"tpl_id":{"description":"智能信息模板ID,由9位数字组成。","example":"600000000","type":"string"}},"type":"object"},"ListResolveTaskResultParam":{"description":"生成短链的响应参数对象。","properties":{"aim_code":{"description":"智能信息编码。样例:PDiWqc。","example":"asides","type":"string"},"aim_url":{"description":"完整的短链连接地址,通过自己的短信渠道发送时,需要把该短链添加到短信模板中,并确保发送短信时的签名与创建短链时的签名保持一致。样例:km2g.cn/PDiWqc。","example":"aim6.cn/asides","type":"string"},"cust_flag":{"description":"创建解析任务时填写用户唯一标识,手机号码或者任何的唯一标识,唯一标识不超过64个字符。 发送智能信息时则必须填客户的手机号码。样例为:130****0001。","example":"130****0001","type":"string"},"cust_id":{"description":"租户ID。","example":"231724915a62455ca356e10a085c0000","type":"string"},"custom_url":{"description":"自定义跳转地址。\n> - 未填时,终端用户点击访问短信原文中的短链,跳转智能信息H5页\n> - 已填时,终端用户点击访问短信原文中的短链,跳转客户填写的链接落地页,填写时必须为http或https作为前缀\n","type":"string"},"dync_params":{"additionalProperties":{"type":"string"},"description":"动态参数。","type":"object"},"error_message":{"description":"短链申请结果错误描述。\n","example":"成功","type":"string"},"expire_date":{"description":"短链到期时间。样例为:2019-10-12T07:20:50。","example":"2019-10-12T07:20:50","type":"string"},"ext_data":{"description":"自定义扩展参数。\n\n>预留字段。\n","type":"string"},"generate_date":{"description":"短链生成时间。样例为:2019-10-12T07:20:50。","example":"2019-10-12T07:20:50","type":"string"},"resolved_date":{"description":"解析时间。样例为:2019-10-12T07:20:50。\n","example":"2019-10-12T07:20:50","type":"string"},"resolved_times":{"description":"短链实际解析次数。\n\n> 预留字段。\n","example":1,"type":"integer"},"result_code":{"description":"短链申请结果返回码。\n- 0:成功\n- 非0:失败,具体请参见错误码\n","example":"0","type":"string"}},"type":"object"},"ListResolveTasksRsp":{"description":"查询短链生成状态响应体。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"resolve_tasks":{"description":"解析任务列表。","items":{"$ref":"#/definitions/ListResolveTaskResult"},"type":"array"}},"type":"object"},"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":"3ebe9f26d94d4e83b8b77ac55a44b999","info_version":"v1","method":"get","name":"ListResolveTasks","parameters":{},"paths":{"/v1/aim/resolve-tasks":{"get":{"consumes":["application/json"],"deprecated":false,"description":"创建解析任务后,客户可以查询解析任务状态信息。\n\n通过模板ID等过滤条件,查询解析任务列表。\n\n如需查询明细,建议使用查询解析明细接口。","operationId":"ListResolveTasks","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":"task_id","required":false,"type":"string"},{"description":"任务名称。","in":"query","maxLength":30,"minLength":0,"name":"task_name","required":false,"type":"string"},{"description":"智能信息模板ID。","in":"query","maxLength":9,"minLength":0,"name":"tpl_id","pattern":"^[0-9]{9}$","required":false,"type":"string"},{"description":"智能信息模板名称。","in":"query","maxLength":100,"minLength":0,"name":"tpl_name","required":false,"type":"string"},{"description":"创建解析任务时填写用户唯一标识,手机号码或者任何的唯一标识,唯一标识不超过64个字符。 发送智能信息时则必须填客户的手机号码。样例为:130****0001。","in":"query","maxLength":100,"minLength":0,"name":"cust_flag","required":false,"type":"string"},{"description":"完整的短链连接地址。样例:km2g.cn/PDiWqc。","in":"query","name":"aim_url","required":false,"type":"string"},{"description":"\n智能信息解析任务创建开始时间。格式为:2019-10-12T07:20:50.522Z。\n\n> 需同时传入end_time才能生效,单独传begin_time不会作为过滤条件。\n>\n> 若不填,则默认查询24小时内创建的解析任务。\n>\n> 仅支持查询最近1年内创建的解析任务。\n","in":"query","maxLength":30,"minLength":0,"name":"begin_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50.52Z"},{"description":"\n智能信息解析任务创建结束时间。格式为:2019-10-12T07:20:50.522Z。\n\n> 需同时传入begin_time才能生效,单独传end_time不会作为过滤条件。\n>\n> 若不填,则默认查询24小时内创建的解析任务。\n","in":"query","name":"end_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50.52Z"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。\n\n>为提高查询效率,offset+limit须小于等于10000,超出范围查询为空。\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":{"page_info":{"limit":2,"offset":0,"total":80},"resolve_tasks":[{"aim_code_type":"individual","domain":"km2g.cn","expiration_time":7,"params":[{"aim_code":"PDiWqc","aim_url":"km2g.cn/PDiWqc","cust_flag":"131****0001","cust_id":"231724915a62455ca356e10a085ccccc","custom_url":"https://www.xxxx.com","dync_params":{"param1":"参数1","param2":"参数2","param3":"参数3","param4":"参数4"},"error_message":"-","expire_date":"2022-07-25T21:00:56","generate_date":"2022-07-18T21:00:56","resolved_date":"2022-07-21T11:43:00","result_code":"0"}],"resolved_times":1,"resolving_times":1,"sms_signs":["华为云KooMessage"],"task_id":"30d6db9b-cc8a-4dc9-a314-d80d3fd0dbea","task_name":"ZF2","tpl_id":"600000001"},{"aim_code_type":"individual","domain":"km2g.cn","expiration_time":7,"params":[{"aim_code":"PDeag3","aim_url":"km2g.cn/PDeag3","cust_flag":"131****0000","cust_id":"231724915a62455ca356e10a085ccccc","custom_url":"https://www.xxxx.com","dync_params":{"param1":"参数1","param2":"参数2","param3":"参数3","param4":"参数4"},"error_message":"-","expire_date":"2022-07-25T21:00:56","generate_date":"2022-07-18T21:00:56","result_code":"0"}],"resolved_times":0,"resolving_times":1,"sms_signs":["华为云KooMessage"],"task_id":"30d6db9b-cc8a-4dc9-a314-d80d3fd0dbea","task_name":"ZFJ1","tpl_id":"600000001"}]}},"schema":{"$ref":"#/definitions/ListResolveTasksRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"summary":"查询解析任务","tags":["AIMResolveTask"],"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.com/v1/aim/resolve-tasks?offset=0&limit=2","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"}