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":{"ListVmsTemplateStatusResponseMode":{"description":"智能信息基础版模板状态查询返回体。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"templates":{"description":"智能信息基础版模板列表。","items":{"$ref":"#/definitions/VmsTemplateStatus"},"maxItems":200,"minItems":0,"type":"array"}},"type":"object"},"ListVmsTemplateStatusRsp":{"properties":{"data":{"$ref":"#/definitions/ListVmsTemplateStatusResponseMode"},"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"}}},"StatusDetail":{"properties":{"carrier":{"description":"运营商类型。\n\n- cmcc:中国移动\n- cucc:中国联通\n- ctcc:中国电信\n- oversea:港澳台及国外\n- unknown:未知\n","type":"string"},"desc":{"description":"对模板状态的描述。\n\n> 若状态是审核不通过或被禁用,描述表示的是不通过或禁用的原因。\n","type":"string"},"status":{"description":"模板状态:\n- 0:正常可用 \n- 1:审核中 \n- 2:审核不通过 \n- 3:模板已禁用 \n- 4:模板不存在 \n- 5:模板已过期\n","type":"integer"}}},"VarInfo":{"properties":{"name":{"description":"动参变量占位符名称。\n\n> 格式:#p_N#(N表示第几个参数,与模板文件占位名称保持一致),如:#p_1#。\n","type":"string"},"type":{"description":"动参变量类型。\n\n- 类型为文字:txt\n- 类型为图片:jpg/jpeg/png/gif\n- 类型为音频:mp3/wav\n- 类型为视频:mp4/3gp\n","type":"string"}}},"VmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}},"VmsTemplateStatus":{"description":"查询智能信息基础版模板返回体。","properties":{"audit_desc":{"description":"智能信息基础版模板状态的描述,若状态是审核不通过或被禁用,描述表示的是不通过或禁用的原因。\n> 长度不超过 1024 字。\n","example":"审核通过","type":"string"},"audit_state":{"description":"智能信息基础版审核状态。\n- 0:正常可用\n- 1:审核中\n- 2:审核不通过\n- 3:模板已禁用\n- 4:模板不存在\n- 5:模板已过期\n","example":1,"format":"int32","type":"integer"},"create_time":{"description":"智能信息基础版模板创建时间,格式:yyyy-MM-ddTHH:mm:ssZ。","type":"string"},"preview_url":{"description":"智能信息基础版模板预览地址。","type":"string"},"restags":{"description":"资源分配标签,取值如下:\n- 三网一般\n- 三网抗诉\n- 单网一般\n- 单网抗诉\n","type":"string"},"status_detail":{"description":"运营商的模板状态详情。","items":{"$ref":"#/definitions/StatusDetail"},"type":"array"},"title":{"description":"智能信息基础版模板主题。","type":"string"},"tpl_id":{"description":"智能信息基础版模板ID。","example":"12121121","type":"string"},"tpl_name":{"description":"智能信息基础版模板名称。","type":"string"},"tpl_sign":{"description":"智能信息基础版模板签名。","type":"string"},"tpl_size":{"description":"智能信息基础版模板的大小。\n\n>  单位:字节。\n","type":"integer"},"valid_time":{"description":"模板截止有效日期,格式:yyyy-MM-ddTHH:mm:ssZ,0:表示永久有效。样例:2020-01-31T23:59:59Z。","type":"string"},"var_info":{"description":"智能信息基础版模板动参信息,静态模板没有动参,该字段填空。","items":{"$ref":"#/definitions/VarInfo"},"type":"array"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"3b2824b2fac149c3912edf0ee234a60c","info_version":"v1","method":"get","name":"ListVmsTemplateStatus","parameters":{},"paths":{"/v1/aim-basic/templates":{"get":{"description":"根据用户提供的过滤条件查询智能信息基础版模板状态列表。\n包括:模板ID、模板名称等。","operationId":"ListVmsTemplateStatus","parameters":[{"description":"智能信息基础版模板ID。","in":"query","name":"tpl_id","required":false,"type":"string"},{"description":"智能信息基础版模板名称。","in":"query","name":"tpl_name","required":false,"type":"string"},{"description":"智能信息基础版模板分类。\n- public:公共模板\n- private:个人模板","in":"query","name":"tpl_type","required":false,"type":"string"},{"description":"智能信息基础版模板是否携带参数,不传查全部模板。","in":"query","name":"has_param","required":false,"type":"boolean"},{"description":"智能信息基础版模板创建开始时间。 样例为:2019-10-12T07:20:50Z。\n\n> begin_time和end_time必须全部为空或全部不为空,并且begin_time不能大于end_time。\n","in":"query","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必须全部为空或全部不为空,并且begin_time不能大于end_time。\n","in":"query","name":"end_time","required":false,"type":"string","x-example":"2019-10-12T07:20:50Z"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","in":"query","maximum":1000000,"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":"查询智能信息基础版模板状态返回体。","examples":{"application/json":{"data":{"page_info":{"limit":20,"offset":0,"total":1},"templates":[{"audit_desc":"模板签名被禁用","audit_state":3,"create_time":"2022-07-01T14:58:06Z","preview_url":"https://rcos.800ct.com:57156/preview/27Em/6592288c6f55da18296824f9d806ddab.html","restags":"三网一般","status_detail":[{"carrier":"cmcc","desc":"正常可用","status":0},{"carrier":"ctcc","desc":"模板已禁用","status":3},{"carrier":"cucc","desc":"正常可用","status":0}],"tpl_id":"800000001","tpl_name":"测试-正能量","tpl_sign":"华为云","tpl_size":0,"valid_time":"2022-09-29T23:59:59Z","var_info":[{"name":"#p_1#","type":"txt"}]}]},"message":"success","status":"200"}},"schema":{"$ref":"#/definitions/ListVmsTemplateStatusRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/VmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/VmsErrorMsg"}}},"summary":"查询智能信息基础版模板状态","tags":["VmsTemplate"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-request-examples-description-1":"查询智能信息基础版模板状态,模板类型为公共模板。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-basic/templates?limit=20&offset=1&tpl_type=public","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"}