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":{"AIMResolveDetail":{"description":"解析详情。","properties":{"aim_url":{"description":"智能信息短链,通过自己的短信渠道发送时,需要把该短链添加到短信模板中,并确保发送短信时的签名与创建短链时的签名保持一致。","example":"aim6.cn/asides","type":"string"},"cust_flag":{"description":"创建解析任务时填写用户唯一标识,手机号码或者任何的唯一标识,唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为:130****0001。","example":"+8613275857369","type":"string"},"expire_date":{"description":"短链到期时间。样例为:2019-10-12T07:20:50Z。","example":"2019-10-12T07:20:50Z","type":"string"},"generate_date":{"description":"短链生成时间。样例为:2019-10-12T07:20:50Z。","example":"2019-10-12T07:20:50Z","type":"string"},"resolve_id":{"description":"解析详情唯一标识ID。","example":"28f61af50fc9452aa0ed5ea25c3cc3d3","readOnly":true,"type":"string"},"resolved_status":{"description":"解析状态。\n- success:解析成功\n- fail:解析失败\n- unresolved:未解析\n","type":"string"},"resolved_time":{"description":"解析时间。样例为:2019-10-12T07:20:50Z。","example":"2019-10-12T07:20:50Z","type":"string"},"result_code":{"description":"短链申请结果返回码。\n- 0:成功\n- 非0:失败,具体请参见错误码。\n","example":"0","type":"string"},"send_account":{"description":"发送的用户名。","example":"paas_apig_wwx548366_05","readOnly":true,"type":"string"},"task_id":{"description":"任务ID。","example":"1869bbfb86e148adbcc068af3793bf7d","readOnly":true,"type":"string"},"task_name":{"description":"任务名称。","example":"ZF2","type":"string"},"tpl_id":{"description":"智能信息模板ID。","example":"600057584","type":"string"},"tpl_name":{"description":"智能信息模板名称。","example":"【市场案例】通知模板","type":"string"}}},"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"ListAimResolveDetailsRsp":{"description":"查询解析详情返回体。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"resolve_details":{"description":"查询解析结果集。","items":{"$ref":"#/definitions/AIMResolveDetail"},"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":"e332a3c453fb4ded8154382833725a14","info_version":"v1","method":"get","name":"ListAimResolveDetails","parameters":{},"paths":{"/v1/aim/resolve-details":{"get":{"description":"根据用户提供的过滤条件查询个性化解析明细,包括:发送任务ID、发送手机号码等。","operationId":"ListAimResolveDetails","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2000,"minLength":0,"name":"X-Auth-Token","required":true,"type":"string"},{"description":"解析任务ID或者发送任务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","required":false,"type":"string"},{"description":"智能信息模板名称。","in":"query","name":"tpl_name","required":false,"type":"string"},{"description":"创建解析任务时填写用户唯一标识,手机号码或者任何的唯一标识,唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为:130****0001。","in":"query","maxLength":64,"minLength":0,"name":"cust_flag","required":false,"type":"string"},{"description":"签名。","in":"query","maxLength":18,"minLength":0,"name":"sms_sign","required":false,"type":"string"},{"description":"智能信息短链,通过自己的短信渠道发送时,需要把该短链添加到短信模板中,并确保发送短信时的签名与创建短链时的签名保持一致。","in":"query","maxLength":100,"minLength":0,"name":"aim_url","required":false,"type":"string","x-example":"6mnm.cn/Vlgy7U"},{"description":"解析状态。\n- success:解析成功 \n- fail:解析失败 \n- unresolved:未解析","in":"query","name":"resolved_status","required":false,"type":"string"},{"description":"短链创建开始时间。格式为:2019-10-12T07:20:50Z。\n\n> 需同时传入end_time才能生效,单独传begin_time不会作为过滤条件。缺省:查询最近二十四小时数据。\n>\n> 仅支持查询最近1年内创建的短链。\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不会作为过滤条件。缺省:查询最近二十四小时数据。\n","in":"query","maxLength":30,"minLength":0,"name":"end_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。\n\n>为提高查询效率,offset+limit须小于等于10000,超出范围查询为空。\n","in":"query","maximum":1000000,"minimum":0,"name":"offset","required":true,"type":"integer"},{"description":"每页显示的条目数量。\n","in":"query","maximum":100,"minimum":1,"name":"limit","required":true,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"page_info":{"limit":1,"offset":0,"total":18},"resolve_details":[{"aim_url":"km2g.cn/MzNkNP","cust_flag":"131****0000","expire_date":"2022-07-26T08:44:04Z","generate_date":"2022-07-19T08:44:04Z","resolve_id":"29ae28ea-0300-4da1-8e54-6c91319fcccc","resolved_status":"success","resolved_time":"2022-07-19T08:44:31Z","result_code":"0","send_account":"myaccount","task_id":"bf04fc77-12c8-408f-a584-cf3d3e91cccc","task_name":"ZF2","tpl_id":"600000001","tpl_name":"【测试】参数通知模板"}]}},"schema":{"$ref":"#/definitions/ListAimResolveDetailsRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"summary":"查询解析明细","tags":["AIMResolveTask"],"x-is-registered":"Y","x-request-examples-description-1":"根据模板ID查询解析任务明细。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim/resolve-details?tpl_id=606425661&offset=0&limit=1","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"}