华为云首页 用户手册

云消息服务 KOOMESSAGE-创建个人模板:请求参数

云消息服务 KOOMESSAGE-创建个人模板:请求参数

时间：2024-04-01 14:51:08
云消息服务 KOOMESSAGE 智能信息模板

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表2 请求Body参数

参数

是否必选

参数类型

描述

card_id

是

String

布局类型。

  • MultipleImageAndText：多图文类

  • StandardImageAndText：图文类

  • PureText：长文本类

  • VideoImageAndText：视频图文类

  • Video：视频类

  • ECImageAndText：电商类

  • RedPacket：红包类

  • RedPacketPersonal：个性化红包类

  • ImageTextAndVideo：图文视频类

  • Notification1：一般通知类

  • Notification2：增强通知类

  • Carousel：横滑类1

  • CarouselTitle：横滑类2

  • CarouselSquareImage：图片轮播类（1:1）

  • CarouselImageSixteenToNine：图片轮播类（16:9）

  • CarouselVerticalImage：图片轮播类（48:65）

  • CardVoucher：单卡券

  • CardVouchers：多卡券（最多支持四张卡券）

  • Ecommerce：电商多商品类

  • Trip1：机票类

  • Trip2：火车票类

  • Trip3：汽车票类

  • PlaneTrip：增强机票类

  • SimplePoster：海报类

  • NativePureText：超文本普通类

  • NativeImageAndText：超文本增强类

  • ShortVideo：短剧视频类

  • ShortVideoImage：短剧图片类

  • EcommerceCouponVertical：电商领券类竖版

  • EcommerceCouponHorizontal：电商领券类横版

说明：

当送审厂商包含vivo时，各布局类型上传的图片最小像素要求如下：

  • card_id为StandardImageAndText，宽高比为16:9时，图片的最小像素为1088px*612px。

  • card_id为MultipleImageAndText，宽高比为16:9时，图片的最小像素为1088px*612px。

  • card_id为MultipleImageAndText，宽高比为1:1时，图片的最小像素为320px*320px。

  • card_id为Video，宽高比为16:9时，视频封面图片的最小像素为1088px*612px。

  • card_id为RedPacket，宽高比为1:1时，图片的最小像素为320px*320px。

  • card_id为CarouselImageSixteenToNine，宽高比为16:9时，图片的最小像素为1088px*612px。

  • card_id为CarouselSquareImage，宽高比为1:1时，图片的最小像素为1088px*1088px。

  • card_id为CarouselVerticalImage，宽高比为48:65时，图片的最小像素为960px*1300px。

  • card_id为Notification1，宽高比为3:1时，图片的最小像素为576px*192px。

  • card_id为Notification2，宽高比为3:1时，图片的最小像素为576px*192px。

  • card_id为ECImageAndText，宽高比为1:1时，图片的最小像素为1088px*1088px。

tpl_name

是

String

智能信息模板名称。

最小长度：1

最大长度：17

scene

否

String

模板使用场景类型。

最小长度：0

最大长度：10

use_id

是

Integer

模板用途。

  • 1：表示商用

  • 2：表示试商用

说明：

  • 模板用途为1，即“商用”时，所有字段中不允许有测试字样，否则影响送审。

  • 模板用途为2，即“试商用”时，请在模板名称（tpl_name）、模板主标题中增加测试字样。

sub_type

否

Integer

版式子类型。

说明：

  • 当card_id为RedPacket和RedPacketPersonal时，sub_type用于设置按钮样式，1表示静态按钮，2表示动态按钮。目前仅华为厂商支持动态按钮。

  • 当card_id为ECImageAndText时，sub_type用于设置左右按钮组合颜色，默认值为1，1表示左边按钮为橙色，右边按钮为红色；2表示左边按钮为绿色，右边按钮为黄色；3表示左边按钮为绿色，右边按钮为蓝色；4表示左边按钮为紫色，右边按钮为蓝色；5表示左边按钮为黑色，右边按钮为玫粉色。仅华为厂商支持sub_type取值为2、3、4、5。

  • 当card_id为CarouselVerticalImage时，sub_type用于设置按钮颜色，1表示蓝色(默认颜色)、2表示黑色、3表示紫色、4表示金色、5表示粉色、6表示玫粉。仅华为厂商支持sub_type取值为2、3、4、5、6。

  • 当card_id为CardVoucher时，sub_type用于设置按钮样式，1表示静态按钮，2表示动态按钮。目前仅华为厂商支持动态按钮。

  • 当card_id为ShortVideoImage时，sub_type用于设置是否显示播放图标，1表示不显示，2表示显示。

  • 当card_id为EcommerceCouponVertical和EcommerceCouponHorizontal时，sub_type用于设置卡券区是否隐藏。sub_type设置为1，卡券区（position_number为4~7）的visible设置为1，且卡券区（position_number为7）的button_type设置为static或dynamic时，显示卡券区；sub_type设置为2，卡券区（position_number为4~7）的visible设置为0，且卡券区（position_number为7）的button_type设置为空值或不带该字段时，卡券区被隐藏。

sms_example

否

String

要发送的原始文本消息示例。

最小长度：0

最大长度：70

sms_signs

否

Array of strings

短信签名。最多可以传三个签名，发送短信时，只要能匹配其中一个即可。填写的短信签名为企业绑定的签名，每个签名最多20个字，支持输入中文，英文，数字，符号，单个签名内容不包括中括号。

说明：

选择厂商包含VIVO时，此参数必填。

最小长度：1

最大长度：20

数组长度：0 - 3

sms_template

否

String

短信原文模板。参数示例：尊敬的客户，截至[文本0-20]，您本月国内通用流量已使用[数字0-4]GB，使用到[数字0-4]GB，整体上网速度将不高于[数字0-2]Mbps。您可点击[字母0-20]获取[文本0-20]。

说明：

  • 正则类型仅支持文本、字母、数字三种，且长度最大为99，且中括号为英文中括号。静态短信文案加正则动态文案最大值的总字数不超过370个字符

  • 历史遗留字段，建议不再使用

pages

是

Array of PersonalTemplatePage objects

模板协议，最大支持10页协议。

params

否

Array of PersonalTemplateParam objects

模板参数集。

factorys

否

Array of PersonalTemplateFactory objects

需要提交的厂商列表。
表3 PersonalTemplatePage

参数

是否必选

参数类型

描述

page_order

是

Integer

分页显示，指示当前展示第几页，从1开始，最大支持10页。

contents

是

Array of PersonalTemplateFactoryContent objects

该page下的协议内容。
表4 PersonalTemplateFactoryContent

参数

是否必选

参数类型

描述

type

是

String

模板资源类型。

  • text：表示文本

  • image：表示图片

  • video：表示视频

  • button：表示按钮

  • followPub：表示华为服务号，暂不支持

说明：

图片轮播类模板最多可以放5张图片，即card_id为CarouselSquareImage、CarouselImageSixteenToNine、CarouselVerticalImage时，type为image的资源最多有5个。

最小长度：1

最大长度：18

content

否

String

资源类型为Text或Button时，为必填。文本长度限制请参考智能信息模板标准版式要求。

说明：

智能信息模板标准版式要求可登录KooMessage控制台，在创建智能信息模板中查看。

最小长度：0

最大长度：1000

content_child

否

String

子内容。非必填，文本长度限制请参考智能信息模板标准版式要求。

说明：

智能信息模板标准版式要求可登录KooMessage控制台，在创建智能信息模板中查看。

src_type

否

Integer

src类型。资源类型为Image或Video时，该项为必填项。

  • 1：指资源ID

  • 2：指资源地址

说明：

src_type为2，即资源地址时，src或cover内容必须是存储在客户侧服务器上的资源地址。

最小值：1

最大值：10

src

否

String

资源来源，资源类型为Image或Video时，为必填。

说明：

  • 如上src_type为1，即资源ID时，参数填入上传模板素材接口中返回的aim_resource_id，如：691996319597764608

  • 如上src_type为2，即资源地址时，参数填写资源完整的URL，最大长度不超过1000个字符

cover

否

String

视频封面。

说明：

资源类型为Video时，为必填，通过设置视频模板封面图接口设置视频封面。

  • 如上src_type为1，即资源ID时，参数填入上传模板素材接口中返回的aim_resource_id，如：691996319597764608

  • 如上src_type为2，即资源地址时，参数填写资源完整的URL，最大长度不超过1000个字符

最小长度：0

最大长度：1000

is_text_title

否

String

是否为文本标题。

  • true：是

  • false：不是

说明：

不填默认为false。

最小长度：0

最大长度：10

action_type

否

String

功能类型。

  • OPEN_URL：表示跳转H5

  • OPEN_QUICK：表示跳转快应用

  • OPEN_APP：表示跳转APP

  • DIAL_PHONE：表示拉起拨号盘

  • OPEN_SMS：表示新建短信息

  • OPEN_EMAIL：表示打开邮箱

  • OPEN_SCHEDULE：表示新建日程

  • OPEN_MAP：表示位置定位

  • OPEN_BROWSER：表示打开浏览器

  • OPEN_POPUP：表示弹窗

  • COPY_PARAMETER：表示复制

  • VIEW_PIC：表示打开大图

说明：

  • type为Image和Button时为必填项，必须绑定事件

  • type为其他类型时则不必填

  • OPPO厂商点击事件类型只支持打开浏览器、打开快应用、打开APP、跳转H5

  • VIVO厂商点击事件类型不支持打开邮箱、打开地图

  • MEIZU厂商点击事件类型不支持打开大图

  • 横滑类1、横滑类2版式的图片不支持绑定事件，默认与按钮事件一致

  • 三星厂商点击事件类型不支持新建日程、打开大图

position_number

是

Integer

卡片组件的位置序号。

说明：

资源在卡片上相对的位置序号，按照优先从左到右，再从上到下的编排原则，统一编号。

visible

否

Integer

组件是否可见。

  • 0：隐藏（某些组件可设置隐藏）

  • 1：可见

说明：

目前仅针对电商多商品（Ecommerce）、多卡券（CardVouchers）、增强机票类（PlaneTrip）这三种版式起效。

currency_display

否

Integer

是否显示货币符号。

  • 0：隐藏

  • 1：可见

说明：

当模板为电商类时是否显示￥符号，默认可见。

oppo_background

否

String

OPPO红包背景。 当模板为红包类，即card_id为RedPacket时用于指定OPPO厂商红包背景图，具体使用可参考创建红包类模板请求示例。OPPO红包背景图要求宽高比为3:4，建议尺寸为342px*456px。

说明：

  • 当src_type为1时，即资源ID时，参数填入上传模板素材接口中返回的aim_resource_id，如：691996319597764608

  • 当src_type为2时，即资源地址时，参数填写资源完整的URL，最大长度不超过1000个字符

最小长度：0

最大长度：1000

vivo_background

否

String

VIVO红包背景。

说明：

  • 当src_type为1时，即资源ID时，参数填入上传模板素材接口中返回的aim_resource_id，如：691996319597764608

  • 当src_type为2时，即资源地址时，参数填写资源完整的URL，最大长度不超过1000个字符

最小长度：0

最大长度：1000

ratio

否

String

表示短视频模板视频和封面的宽高比。即card_id为ShortVideo时，此项有值。

  • threeToFour：宽高比为3:4

  • oneToOne：宽高比为1:1

action

否

PersonalTemplateFactoryContentAction object

个人模板事件对象。

button_type

否

String

当模板为电商领券类（竖版和横版），即card_id为EcommerceCouponVertical和EcommerceCouponHorizontal时用于指定按钮类型，具体使用可参考创建电商领券类（竖版和横版）模板请求示例。

  • static：静态按钮

  • dynamic：动态按钮
表5 PersonalTemplateFactoryContentAction

参数

是否必选

参数类型

描述

target

是

String

此字段根据action_type对应不同的含义，具体对应如下。

  • action_type=OPEN_URL：表示H5访问地址。必须为HTTPS，支持含动态参数。字符长度为1-1000。示例：https://XXXXX/${param1}

  • action_type=OPEN_QUICK：表示快应用deeplink地址。支持含动态参数，字符长度为1-1000。示例：hap://app/xxx/${param1}

  • action_type=OPEN_APP：表示APP的deeplink地址。支持含动态参数，字符长度为1-1000。示例：weixin://

  • action_type=DIAL_PHONE：表示电话号码。不能超过20个字符。示例：18600000000

  • action_type=OPEN_SMS：表示电话号码。不能超过20个字符。示例：18600000000

  • action_type=OPEN_EMAIL：表示邮箱地址。不能超过100个字符。示例：1046520406@qq.com

  • action_type=OPEN_SCHEDULE：表示日程标题。不能超过100个字符。示例：日常需求评审

  • action_type=OPEN_MAP：表示位置名。不能超过100个字符。示例：龙泰利科技大厦

  • action_type=OPEN_BROWSER：表示网址。支持HTTPS或HTTP，支持含动态参数，不能超过1000个字符。示例：https://XXXXX/${param1}

  • action_type=OPEN_POPUP：表示弹窗标题。不能超过30个字符。参数示例：xxx商品

  • action_type=COPY_PARAMETER：表示复制的内容。支持含动态参数，不能超过20个字符。复制验证码示例：83721

  • action_type=VIEW_PIC：表示要打开的大图ID。配置在打开大图的资源地址与模板上的图片资源地址一致。如果模板资源类型是ID，则传ID，如果是资源地址，则使用资源地址。最大长度不能超过1000个字符。例如：当src_type为1时，传入ID：691996319597764608。当src_type为2时，使用资源地址：https://www.xxxx.cn/src/image/head.jpg

content

否

String

弹窗内容。

说明：

action_type=OPEN_POPUP为必填。不能超过100个字符。示例：是否喜欢该商品。

最小长度：0

最大长度：100

package_name

否

String

包名。

说明：

action_type=OPEN_APP为必填。不能超过50个字符。示例：com.xxxx.service.koomsg。

最小长度：0

最大长度：50

floor_url

否

String

兜底URL。支持快应用deeplink或H5的HTTPS网址，不能超过1000个字。

说明：

  • action_type=OPEN_APP为选填，其他类型不填

  • 兜底类型为0时，可不填

  • 当兜底类型为2并且提交厂商列表中包含OPPO厂商时为必填

最小长度：0

最大长度：1000

floor_type

否

Integer

兜底类型。如果传入的厂商不支持该兜底类型，接口会返回错误。如果不传入厂商，则不对兜底类型进行校。

  • 0：打开应用市场

  • 1：打开H5页面（通过收件箱内置浏览器打开）

  • 2：打开浏览器

  • 3：打开快应用

说明：

action_type=OPEN_APP为选填，其他类型不填；action_type=OPEN_APP时此参数不填则默认打开应用市场。打开链接为http格式时必须选择打开浏览器；打开链接为https格式且内容只是一个普通页面时，可以使用打开H5页面，当链接中有下载指引或打开小程序由于部分内置浏览器功能不全可能导致打开异常，建议使用打开浏览器，请按需选择兜底类型。

  • 华为：支持以上4种兜底

  • 魅族：支持以上4种兜底

  • 小米：不支持打开H5页面兜底

  • OPPO：不支持打开H5页面和打开快应用兜底

  • VIVO：不支持打开H5页面和打开快应用兜底

  • 三星：不支持打开应用市场和打开浏览器。当创建的模板仅包含三星厂商时，兜底URL不支持打开浏览器和打开应用市场；当创建的模板包含三星和其它厂商时，以其它厂商的限制为准，三星的兜底链接将不生效

最小值：0

最大值：3

subject

否

String

邮件标题。

说明：

action_type=OPEN_EMAIL为必填。不能超过100个字符。示例：618活动促销。

body

否

String

邮件正文/短信正文。

说明：

action_type=OPEN_SMS或OPEN_EMAIL为必填。不能超过100个字符。

短信正文示例1：今天回家吃饭吗；

邮件正文示例2：您有一张优惠券领取。

description

否

String

日程内容描述。

说明：

action_type=OPEN_SCHEDULE为必填。不能超过100个字符。示例：评审这个月版本需求。

最小长度：0

最大长度：100

begin_time

否

String

日程开始时间。格式为：yyyy-MM-dd HH:mm:ss。

说明：

当action_type=OPEN_SCHEDULE时为必填。

最小长度：0

最大长度：100

end_time

否

String

日程结束时间。格式为：yyyy-MM-dd HH:mm:ss。

说明：

当action_type=OPEN_SCHEDULE时为必填。

最小长度：0

最大长度：100

address

否

String

地址的详细说明。

说明：

action_type=OPEN_MAP为必填。不能超过100个字符。示例：高新中四道龙泰利科技大厦。

最小长度：0

最大长度：100

longitude

否

String

地图经度。

说明：

action_type=OPEN_MAP为必填。不能超过20个字符。示例：113.941618。

最小长度：0

最大长度：20

latitude

否

String

地图纬度。

说明：

action_type=OPEN_MAP为必填。不能超过20个字符。示例：22.548804。

最小长度：0

最大长度：20

text_button

否

String

按钮展示文本。

说明：

action_type=OPEN_POPUP为必填。不能超过12个字符。示例：确定。

最小长度：0

最大长度：12

mode

否

Integer

弹窗模态。

  • 0：模态（默认）

  • 1：非模态（暂不支持）

说明：

action_type=OPEN_POPUP为必填。
表6 PersonalTemplateParam

参数

是否必选

参数类型

描述

type

是

Integer

动态参数类型。1：表示文本类型。

最小值：0

最大值：100

name

是

String

动态参数名称。示例：${param1}。

最小长度：1

最大长度：20

example

是

String

参数示例，动态参数对应的示例，不能大于100个字符。

最小长度：1

最大长度：100
表7 PersonalTemplateFactory

参数

是否必选

参数类型

描述

factory_type

是

String

厂商类型。

  • HUAWEI：华为

  • XIAOMI：小米

  • OPPO：OPPO

  • VIVO：VIVO

  • MEIZU：魅族

  • SAMSUNG：三星

各厂商支持的布局类型，布局类型与card_id字段相对应。分别如下：

  • HUAWEI：多图文类（MultipleImageAndText）、图文类（StandardImageAndText）、长文本类（PureText）、横滑类1（Carousel）、横滑类2（CarouselTitle）、视频图文类（VideoImageAndText）、视频类（Video）、电商类（ECImageAndText）、红包类（RedPacket）、个性化红包类（RedPacketPersonal）、增强通知类（Notification2）、图片轮播类1:1（CarouselSquareImage）、图片轮播类16:9（CarouselImageSixteenToNine）、图片轮播类48:65（CarouselVerticalImage）、图文视频类（ImageTextAndVideo）、一般通知类（Notification1）、单卡券（CardVoucher）、多卡券（CardVouchers）、电商多商品类（Ecommerce）、电商领券类竖版（EcommerceCouponVertical）、电商领券类横版（EcommerceCouponHorizontal）、机票类（Trip1）、火车票类（Trip2）、汽车票类（Trip3）、增强机票类（PlaneTrip）、海报类（SimplePoster）、超文本普通类（NativePureText）、超文本增强类（NativeImageAndText）、短剧视频类（ShortVideo）、短剧图片类（ShortVideoImage）

  • XIAOMI：多图文类（MultipleImageAndText）、图文类（StandardImageAndText）、红包类（RedPacket）、增强通知类（Notification2）、一般通知类（Notification1）

  • OPPO：多图文类（MultipleImageAndText）、图文类（StandardImageAndText）、长文本类（PureText）、横滑类（Carousel）、视频类（Video）、电商类（ECImageAndText）、红包类（RedPacket）、图片轮播类1:1（CarouselSquareImage）、图片轮播类16:9（CarouselImageSixteenToNine）、图片轮播类48:65（CarouselVerticalImage）

  • MEIZU：多图文类（MultipleImageAndText）、图文类（StandardImageAndText）、横滑类1（Carousel）、横滑类2（CarouselTitle）

  • VIVO：多图文类（MultipleImageAndText）、图文类（StandardImageAndText）、图片轮播类1:1（CarouselSquareImage）、图片轮播类16:9（CarouselImageSixteenToNine）、图片轮播类48:65（CarouselVerticalImage）、视频类（Video）、电商类（ECImageAndText）、红包类（RedPacket）、增强通知类（Notification2）、一般通知类（Notification1）

  • 三星：多图文类（MultipleImageAndText）、图文类（StandardImageAndText）、长文本类（PureText）、横滑类1（Carousel）、横滑类2（CarouselTitle）、视频图文类（VideoImageAndText）、视频类（Video）、电商类（ECImageAndText）、红包类（RedPacket）、图片轮播类1:1（CarouselSquareImage）、图片轮播类16:9（CarouselImageSixteenToNine）、图片轮播类48:65（CarouselVerticalImage）、图文视频类（ImageTextAndVideo）、一般通知类（Notification1）、机票类（Trip1）、火车票类（Trip2）、汽车票类（Trip3）

最小长度：1

最大长度：16

state

是

Integer

支持状态。

  • 1：支持

  • 0：不支持

最小值：0

最大值：1
support.huaweicloud.com/api-koomessage/CreatePersonalTemplate.html
看了此文的人还看了
CDN加速 GaussDB 文字转换成语音 免费的服务器 如何创建网站 域名网站购买 私有云桌面 云主机哪个好 域名怎么备案 手机云电脑 SSL证书申请 云点播服务器 免费OCR是什么 电脑云桌面 域名备案怎么弄 语音转文字 文字图片识别 云桌面是什么 网址安全检测 网站建设搭建 国外CDN加速 SSL免费证书申请 短信批量发送 图片OCR识别 云数据库MySQL 个人域名购买 录音转文字 扫描图片识别文字 OCR图片识别 行驶证识别 虚拟电话号码 电话呼叫中心软件 怎么制作一个网站 Email注册网站 华为VNC 图像文字识别 企业网站制作 个人网站搭建 华为云计算 免费租用云托管 云桌面云服务器 ocr文字识别免费版 HTTPS证书申请 图片文字识别转换 国外域名注册商 使用免费虚拟主机 云电脑主机多少钱 鲲鹏云手机 短信验证码平台 OCR图片文字识别 SSL证书是什么 申请企业邮箱步骤 免费的企业用邮箱 云免流搭建教程 域名价格
云消息服务 KOOMESSAGE-创建个人模板:请求参数

搜索反馈

您搜索到想要的结果了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
热门活动
推荐文章
更多内容
云硬盘存储EVS Web应用防火墙 人机语音识别 开发者大会2023 云计算入门 云数据库选择 HDC大会 华为云计算 响应式建站是什么 智慧班牌系统