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":{"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"AimSendReport":{"description":"报表详情。","properties":{"report_time":{"description":"报表日期时间。","example":"2022-05-10","type":"string"},"resolve_success_count":{"description":"成功解析数量。","example":0,"type":"integer"},"send_count":{"description":"发送数量。","example":0,"type":"integer"},"send_success_count":{"description":"成功发送数量。","example":0,"type":"integer"},"submission_count":{"description":"提交号码总数量。","example":0,"type":"integer"},"support_resolve_count":{"description":"支持解析数量。\n\n> 此数据不包括通过API发送的智能信息任务。\n","example":0,"type":"integer"},"tpl_id":{"description":"智能信息模板ID。","example":"111111111","type":"string"},"tpl_name":{"description":"智能信息模板名称。","example":"模板名称","type":"string"}}},"ListAimSendReportsMode":{"description":"报表数据体。","properties":{"data_list":{"description":"数据列表。","items":{"$ref":"#/definitions/AimSendReport"},"maxItems":100,"minItems":0,"type":"array"},"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"}}},"ListAimSendReportsRequestBody":{"description":"查询智能信息报表请求体。","properties":{"begin_time":{"description":"开始时间。格式为:2022-05-01T00:00:00Z。","maxLength":30,"minLength":0,"type":"string"},"end_time":{"description":"结束时间。格式为:2022-05-01T00:00:00Z。","maxLength":30,"minLength":0,"type":"string"},"limit":{"description":"每页显示的条目数量。\n","example":10,"maximum":100,"minimum":1,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。\n\n> 为提高查询效率,offset+limit须小于等于10000,超出范围查询为空。\n","example":0,"maximum":2147483647,"minimum":0,"type":"integer"},"report_type":{"description":"报表类型。\n\n- 1:日报表\n- 2:月报表\n\n> 若不填,默认是1,即查询日报表。\n","example":"1","maxLength":8,"minLength":0,"type":"string"},"tpl_id":{"description":"智能信息模板ID。","example":"600062095","maxLength":9,"minLength":0,"type":"string"},"tpl_name":{"description":"智能信息模板名称。","example":"测试模板","maxLength":100,"minLength":0,"type":"string"}}},"ListAimSendReportsRsp":{"description":"报表查询响应结果。","properties":{"data":{"$ref":"#/definitions/ListAimSendReportsMode","description":"响应数据体。"},"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"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"b36c58425c284e6aac12304ed2d09012","info_version":"v1","method":"post","name":"ListAimSendReports","parameters":{},"paths":{"/v1/aim/send-reports":{"post":{"description":"查询智能信息发送报表。","operationId":"ListAimSendReports","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2000,"minLength":0,"name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"消息发送请求体","in":"body","name":"ListAimSendReportsRequestBody","required":true,"schema":{"$ref":"#/definitions/ListAimSendReportsRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"data":{"data_list":[{"report_time":"2022-07-15","resolve_success_count":0,"send_count":0,"send_success_count":0,"submission_count":4,"support_resolve_count":3,"tpl_id":"600000005","tpl_name":"【惠游重庆】入境欢迎-测试"}],"page_info":{"limit":2,"offset":1,"total":1}},"message":"success","status":"200"}},"schema":{"$ref":"#/definitions/ListAimSendReportsRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"summary":"查询智能信息发送报表","tags":["AIMSendTask"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-request-examples-1":{"begin_time":"2022-07-15T00:00:00Z","end_time":"2022-07-16T00:00:00Z","limit":2,"offset":0,"report_type":"1","tpl_id":"600000005"},"x-request-examples-2":{"begin_time":"2022-05-01T00:00:00Z","end_time":"2022-07-01T00:00:00","limit":2,"offset":0,"report_type":"2","tpl_id":"600000006"},"x-request-examples-description-1":"查询智能信息发送报表-日报。模板ID为\"600000005\",查询时间从\"2022-07-15 00:00:00 到 2022-07-16 00:00:00\"。","x-request-examples-description-2":"查询智能信息发送报表-月报。模板ID为\"600000006\",查询时间从\"2022-05-01 00:00:00 到 2022-07-01 00:00:00\"。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.com/v1/aim/send-reports","x-request-examples-url-2":"https://koomessage.myhuaweicloud.com/v1/aim/send-reports","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"}