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":{"CreateVmsTemplateRequestBody":{"description":"新建智能信息基础版模板的请求消息体。","properties":{"callbackurl":{"description":"客户系统回调URL,可用于通知对端模板审核状态信息。\n\n> 接口规格需参照定义智能信息基础版模板状态回执完成实现。\n","example":"htts://ip:port/xxx","type":"string"},"expiration_time":{"description":"智能信息基础版模板有效期。单位:天,必须取整,最长9999天。","example":"90","type":"string"},"is_draft":{"default":0,"description":"以草稿状态提交模板。\n- 0:非草稿模板\n- 1:草稿模板\n","type":"integer"},"remarks":{"description":"智能信息基础版模板备注信息,用于填写对模板审核的期望或要求,最大不超过200个字。例如:希望这个模板绑定的通道类型是三网合一通道,默认优先绑定三网合一通道。","example":"希望30分钟内完成审批","type":"string"},"reslist":{"description":"\n模板资源列表,由按顺序排列的资源组成,资源类型支持文本、图片、音频、视频。\n\n> 资源在JSON数组中的顺序将决定其在手机上的显示顺序,数组大小不能超过10。\n","items":{"$ref":"#/definitions/ResourceInfo"},"maxItems":10,"minItems":1,"type":"array"},"title":{"description":"智能信息基础版模板主题,最大不超过20个字,若使用中文需经过UTF-8 编码,主题不能包含“【】”,否则审核会不通过。","example":"测试模板","type":"string"},"tpl_name":{"description":"智能信息基础版模板名称。模板的别名,用来帮助记忆。最大不超过100个字,若使用中文需经过UTF-8编码。","example":"测试模板","type":"string"}},"required":["expiration_time","reslist","title","tpl_name"],"type":"object"},"CreateVmsTemplateRsp":{"description":"新建智能信息基础版模板的答复消息体","properties":{"tplid":{"description":"智能信息基础版模板ID,用来唯一标识上传的模板。","example":"12121121","type":"string"}},"type":"object"},"ResourceInfo":{"description":"智能信息基础版资源信息。","properties":{"content":{"description":"智能信息基础版。\n- 当source=txt时,填写经过UTF-8编码的文字\n- 当source=file时,填写经过Base64编码的文件流,不须带文件格式前缀,样例:\"iVBORw0KGgoAAAANSUhEUgA...\",样例过长,未显示全部\n- 当source=url时,填写资源URL地址,URL长度不能超过1024个字节\n\n> - 支持文字图片,文字和图片使用#p_n#参数变量占位,n为1~100内的数字,不同类型的资源中不允许有重复的参数占位符,相同类型的资源同一参数占位符可复用。如:#p_1#已表示是文本参数占位符时,不可以同时是图片又是文本参数占位符。不能包含除模板签名外的“【】” > - 第一个文本帧,内容必须以:【签名】开始,'签名' 标识客户信息\n","example":"【签名】尊敬的#p_1#你好,你#p_2#月的账单如下","type":"string"},"index":{"description":"智能信息基础版序号。\n\n从1开始,例如: 1-1,表示第1帧第1个元素;1-2:表示第1帧第2个元素;2-1:表示第2帧第1个元素。\n\n> - 每帧支持最多2个元素,2个元素中必须包含有文本\n> - 如果未填该字段,则每个元素独占一帧并按数组顺序排序\n> - 最多支持8帧\n> - 最多2帧同时包含2个元素\n> - index必须全部指定,或者全为空,不能重复\n","example":"1-1","type":"string"},"name":{"description":"智能信息基础版资源名称。","example":"文本.txt","type":"string"},"source":{"description":"智能信息基础版资源来源。\n\n- txt:表示资源内容是纯文字\n- file:表示资源内容来源于文件流\n- url:表示资源内容来源于URL外链\n\n> 资源来自于文字/文件流/URL外链。\n","example":"txt","type":"string"},"type":{"description":"智能信息基础版资源类型。\n- 类型为文字填:txt\n- 类型为图片填:jpg/jpeg/png/gif\n- 类型为音频填:mp3/wav\n- 类型为视频填:3gp\n","example":"txt","type":"string"}},"required":["content","name","source","type"],"type":"object"},"VmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"e15fa62bf965486291209ddcb5ff8dec","info_version":"v1","method":"post","name":"CreateVmsTemplate","parameters":{},"paths":{"/v1/aim-basic/templates":{"post":{"description":"支持用户通过此接口创建智能信息基础版模板。\n","operationId":"CreateVmsTemplate","parameters":[{"description":"创建模板请求头","in":"body","name":"CreateVmsTemplateRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateVmsTemplateRequestBody"}},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"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":{"tplid":"800000001"}},"schema":{"$ref":"#/definitions/CreateVmsTemplateRsp"}},"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-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"}