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":{"Page":{"description":"分页信息。","properties":{"limit":{"description":"每页显示的条目数量。","example":20,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","example":1,"type":"integer"},"total":{"description":"总条数。","example":222,"type":"integer"}}},"SmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","maxLength":32,"minLength":0,"type":"string"},"error_msg":{"description":"结果详情。","maxLength":32,"minLength":0,"type":"string"}},"type":"object"},"SmsPageResponse3":{"description":"短信记录查询结果。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"result":{"description":"查询结果。","items":{"$ref":"#/definitions/SmsTemplateInfo"},"type":"array"}},"type":"object"},"SmsTemplateInfo":{"properties":{"app_id":{"description":"应用ID。","maxLength":50,"minLength":1,"type":"string"},"app_name":{"description":"应用名称。","maxLength":30,"minLength":1,"type":"string"},"create_time":{"description":"创建时间。","maxLength":20,"minLength":1,"type":"string"},"flow_status":{"description":"流程状态。","maxLength":20,"minLength":1,"type":"string"},"has_variable":{"description":"是否有变量。","maxLength":10,"minLength":1,"type":"string"},"review_desc":{"description":"审批描述。","maxLength":500,"minLength":0,"type":"string"},"signature_id":{"description":"签名ID。","maxLength":50,"minLength":1,"type":"string"},"status":{"description":"模板状态。","maxLength":20,"minLength":1,"type":"string"},"template_content":{"description":"模板内容。","maxLength":500,"minLength":1,"type":"string"},"template_desc":{"description":"申请描述。","maxLength":100,"minLength":1,"type":"string"},"template_id":{"description":"模板ID。","maxLength":50,"minLength":1,"type":"string"},"template_name":{"description":"模板名称。","maxLength":30,"minLength":1,"type":"string"},"template_type":{"description":"模板类型。","maxLength":20,"minLength":1,"type":"string"},"universal_template":{"description":"是否是通用模板。","maximum":1,"minimum":0,"type":"integer"},"urge_desc":{"description":"催审描述。","maxLength":64,"minLength":0,"type":"string"},"urge_status":{"description":"催审状态。","maxLength":20,"minLength":0,"type":"string"},"urge_time":{"description":"催审时间。","maxLength":20,"minLength":1,"type":"string"}},"type":"object"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"1e4948718269464498b6f65eb2f77279","info_version":"v1","method":"get","name":"ListAimMsgTemplate","parameters":{},"paths":{"/v1/sms/templates":{"get":{"description":"该接口用于用户查询已创建的短信模板。","operationId":"ListAimMsgTemplate","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"default":1,"description":"偏移量。表示从偏移量开始查询,offset大于等于0。","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"default":10,"description":"每页显示的条目数量。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"应用名称。","in":"query","name":"app_name","required":false,"type":"string"},{"description":"开始时间。","in":"query","name":"start_time","required":false,"type":"string"},{"description":"结束时间。","in":"query","name":"end_time","required":false,"type":"string"},{"description":"流程状态。","enum":["Adopted:通过","Reviewing:审核中","Reject:拒绝"],"in":"query","name":"flow_status","required":false,"type":"string"},{"description":"模板ID。","in":"query","name":"template_id","required":false,"type":"string"},{"description":"模板名称。","in":"query","name":"template_name","required":false,"type":"string"},{"description":"模板类型。","enum":["PROMOTION_TYPE:营销类","NOTIFY_TYPE:通知类"],"in":"query","name":"template_type","required":false,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"查询短信模板响应体。","examples":{"application/json":{"page_info":{"limit":2,"offset":1,"total":148},"result":[{"app_id":"707b236a-b58b-41fc-b552-****eaaa19af","app_name":"APP1","create_time":"2023-08-04 07:53:40","flow_status":"Adopted","has_variable":"Yes","review_desc":"请审批","signature_id":"65ba0c56-aa84-4e68-86a7-****62c50707","status":"Normal","template_content":"华为云内部测试使用。${1} 回T取关","template_desc":"","template_id":"1512***6","template_name":"营销类07模板","template_type":"PROMOTION_TYPE","universal_template":null,"urge_desc":null,"urge_status":"NO","urge_time":null},{"app_id":"707b236a-b58b-41fc-b552-****eaaa19af","app_name":"APP1","create_time":"2023-08-04 07:45:08","flow_status":"Adopted","has_variable":"Yes","review_desc":"请审批","signature_id":"af98bc62-cc8b-407e-a37a-****726c19d6","status":"Normal","template_content":"测试一体化营销套餐006号${1} 回T取关","template_desc":"","template_id":"1512***5","template_name":"营销类06模板","template_type":"PROMOTION_TYPE","universal_template":null,"urge_desc":null,"urge_status":"NO","urge_time":null}]}},"schema":{"$ref":"#/definitions/SmsPageResponse3"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/SmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/SmsErrorMsg"}}},"schemes":["https"],"security":[{"apig-auth-iam":[]}],"summary":"查询短信模板","tags":["AimSmsTemplate"],"x-api-type":"open-api","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"GET","name":"lb-km-aim","path":"/v1/sms/templates","scheme":"https","timeout":30000},"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-query-string-encode":"ENABLE","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":1,"x-request-examples-description-1":"查询状态为审核通过的短信模板。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/templates?flow_status=Adopted","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"}