云消息服务 KooMessage-新建智能信息基础版模板:请求参数

时间:2023-11-01 16:19:01

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

请求体参数类型,该字段必须设置为:application/json。

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表2 请求Body参数

参数

是否必选

参数类型

描述

expiration_time

String

智能信息基础版模板有效期。单位:天,必须取整,最长9999天。

tpl_name

String

智能信息基础版模板名称。模板的别名,用来帮助记忆。最大不超过100个字,若使用中文需经过UTF-8编码。

title

String

智能信息基础版模板主题,最大不超过20个字,若使用中文需经过UTF-8 编码,主题不能包含“【】”,否则审核会不通过。

reslist

Array of ResourceInfo objects

模板资源列表,由按顺序排列的资源组成,资源类型支持文本、图片、音频、视频。

说明:

资源在JSON数组中的顺序将决定其在手机上的显示顺序,数组大小不能超过10。

remarks

String

智能信息基础版模板备注信息,用于填写对模板审核的期望或要求,最大不超过200个字。例如:希望这个模板绑定的通道类型是三网合一通道,默认优先绑定三网合一通道。

callbackurl

String

客户系统回调URL,可用于通知对端模板审核状态信息。

说明:

接口规格需参照定义智能信息基础版模板状态回执完成实现。

表3 ResourceInfo

参数

是否必选

参数类型

描述

index

String

智能信息基础版序号。

从1开始,例如: 1-1,表示第1帧第1个元素;1-2:表示第1帧第2个元素;2-1:表示第2帧第1个元素。

说明:
  • 每帧支持最多2个元素,2个元素中必须包含有文本

  • 如果未填该字段,则每个元素独占一帧并按数组顺序排序

  • 最多支持8帧

  • 最多2帧同时包含2个元素

  • index必须全部指定,或者全为空,不能重复

type

String

智能信息基础版资源类型。

  • 类型为文字填:txt

  • 类型为图片填:jpg/jpeg/png/gif

  • 类型为音频填:mp3/wav

  • 类型为视频填:mp4/3gp

name

String

智能信息基础版资源名称。

source

String

智能信息基础版资源来源。

  • txt:表示资源内容是纯文字

  • file:表示资源内容来源于文件流

  • url:表示资源内容来源于URL外链

说明:

资源来自于文字/文件流/URL外链。

content

String

智能信息基础版资源信息内容。

  • 当source=txt时,填写经过UTF-8编码的文字

  • 当source=file时,填写经过Base64编码的文件流,不须带文件格式前缀,样例:"iVBORw0KGgoAAAANSUhEUgA...",样例过长,未显示全部

  • 当source=url时,填写资源URL地址,URL长度不能超过1024个字节

说明:
  • 文字中可以使用#p_n#参数变量占位,n为1~100内的数字,相同类型的资源同一参数占位符可复用。如:#p_1#已表示是文本参数占位符时,其它位置的文本类型资源可以包含该文本参数占位符。不能包含除模板签名外的“【】”

  • 第一个文本帧,内容必须以:【签名】开始,“签名” 标识客户信息

support.huaweicloud.com/api-koomessage/CreateTemplate.html