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":{"SmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","maxLength":32,"minLength":0,"type":"string"},"error_msg":{"description":"结果详情。","maxLength":32,"minLength":0,"type":"string"}},"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":"d59d811bec6b484da32c091a900f3c7e","info_version":"v1","method":"get","name":"ShowAimMsgTemplateDetail","parameters":{},"paths":{"/v1/sms/templates/{template_id}":{"get":{"description":"该接口用于用户获取已创建的短信模板详情。","operationId":"ShowAimMsgTemplateDetail","parameters":[{"description":"短信模板ID。","in":"path","name":"template_id","required":true,"type":"string"},{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"获取短信模板详情响应体。","examples":{"application/json":{"app_id":"707b236a-b58b-41fc-b552-****eaaa19af","app_name":"NewOPACCOUNT082","create_time":"2023-08-08 06:14:56","flow_status":"Reviewing","has_variable":"Yes","review_desc":null,"signature_id":"65ba0c56-aa84-4e68-86a7-****62c50707","status":"Normal","template_content":"尊敬的华为云会员,详情请咨询4000-955**** ${1} ","template_desc":"模板测试","template_id":"1512***3","template_name":"模板测试AAB","template_type":"PROMOTION_TYPE","universal_template":null,"urge_desc":null,"urge_status":"NO","urge_time":null}},"schema":{"$ref":"#/definitions/SmsTemplateInfo"}},"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/{id}","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":3,"x-request-examples-description-1":"获取ID为\"1512***3\"的短信模板详情。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/templates/1512***3","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"}