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":{"ListVmsSendTasksResponseMode":{"description":"查询发送任务列表响应体。","properties":{"aim_basic_send_tasks":{"description":"智能信息基础版任务查询列表。","items":{"$ref":"#/definitions/VmsSendTask"},"maxItems":100,"minItems":0,"type":"array"},"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"}}},"ListVmsSendTasksRsp":{"properties":{"data":{"$ref":"#/definitions/ListVmsSendTasksResponseMode"},"message":{"description":"响应信息。","example":"success","type":"string"},"status":{"description":"状态码。","example":"200","type":"string"}}},"Page":{"description":"分页信息。","properties":{"limit":{"description":"每页显示的条目数量。","example":20,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","example":1,"type":"integer"},"total":{"description":"总条数。","example":222,"type":"integer"}}},"VmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}},"VmsSendTask":{"description":"智能信息基础版任务详情。","properties":{"create_time":{"description":"智能信息基础版任务创建时间。","example":"2022-05-30T17:23:00","type":"string"},"exdata":{"description":"扩展字段。\n\n> 预留字段。\n","example":"自己添加的说明","type":"string"},"failed_count":{"description":"已经发送失败的手机号码总数。","example":10,"type":"integer"},"operator":{"description":"操作员。","example":"paas_apig_wwx548366_05","type":"string"},"send_time":{"description":"智能信息基础版任务发送时间。","example":"2022-05-30T17:23:00","type":"string"},"success_count":{"description":"已经发送成功的手机号码总数。","example":80,"type":"integer"},"task_id":{"description":"智能信息基础版任务ID。","example":"a087f6e7-f436-4500-bc64-b7b41ff95c10","type":"string"},"task_name":{"description":"智能信息基础版任务名称。","example":"任务名称","type":"string"},"task_state":{"description":"智能信息基础版任务状态。","example":"发送中","type":"string"},"timeout_count":{"description":"已经发送超时失败的手机号码总数(72小时没接收到状态认定为超时失败)。","example":0,"type":"integer"},"total_count":{"description":"需要发送的手机号码总数(有效号码总数)。","example":100,"type":"integer"},"tpl_id":{"description":"智能信息基础版模板ID。","example":"800310341","type":"string"},"tpl_name":{"description":"智能信息基础版模板名称。","example":"测试-模板","type":"string"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"615a129e0a7142b1bdb6d97c589fb9ad","info_version":"v1","method":"get","name":"ListVmsSendTasks","parameters":{},"paths":{"/v1/aim-basic/send-tasks":{"get":{"consumes":["application/json"],"description":"支持用户根据过滤条件查询智能信息基础版任务列表。包括:发送任务名称、智能信息基础版模板ID等。","operationId":"ListVmsSendTasks","parameters":[{"description":"智能信息基础版任务名称。","in":"query","name":"task_name","required":false,"type":"string"},{"description":"智能信息基础版任务ID。","in":"query","name":"task_id","required":false,"type":"string"},{"description":"智能信息基础版模板ID。","in":"query","name":"tpl_id","required":false,"type":"string"},{"description":"智能信息基础版模板名称。","in":"query","name":"tpl_name","required":false,"type":"string"},{"description":"智能信息基础版任务创建开始时间。 样例为:2019-10-12T07:20:50Z。","in":"query","name":"begin_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"智能信息基础版任务创建结束时间。 样例为:2019-10-12T07:20:50Z。","in":"query","name":"end_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"智能信息基础版任务发送开始时间。 样例为:2019-10-12T07:20:50Z。","in":"query","name":"send_begin_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"智能信息基础版任务发送结束时间。 样例为:2019-10-12T07:20:50Z。","in":"query","name":"send_end_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"description":"操作员。","in":"query","name":"operator","required":false,"type":"string"},{"description":"发送状态类型。\n- submit_success:提交成功\n- submit_failed:提交失败\n- processing:发送中\n- sending_failed:发送失败\n- re_submit_success:重试提交成功\n- sending_complete:发送完成\n- re_submit_failed:重试提交成功\n- re_processing:重试进行中\n- re_sending_complete:重试发送完成\n- scheduled:定时任务","in":"query","name":"task_status","required":false,"type":"string"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":20,"description":"每页显示的条目数量。","in":"query","maximum":100,"minimum":1,"name":"limit","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":"查询智能信息基础版任务列表返回体。","schema":{"$ref":"#/definitions/ListVmsSendTasksRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/VmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/VmsErrorMsg"}}},"schemes":["https"],"security":[{"apig-auth-iam":[]}],"summary":"查询智能信息基础版发送任务","tags":["VMSSendTask"],"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-basic/send-tasks?task_name&task_id","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"}