卡片短信模板参数说明

更新时间:2024-11-11 02:34:08

本文为您介绍调用CreateCardSmsTemplate接口,创建模板时的参数字段说明。

Template参数说明

字段

是否必填

类型

描述

字段

是否必填

类型

描述

extendInfo

Object

扩展字段,具体字段说明请参见ExtendInfo字段说明

templateContent

Object

卡片短信模板内容,具体字段说明请参见TemplateContent字段说明

cardSignName

String

卡片短信模板签名,生成短链时需要。

cardType

Integer

卡片模板类型。取值:

  • 1:横滑类1模板

  • 2:横滑类2模板

  • 3:一般通知模板

  • 4:视频模板

  • 5:图文模板

  • 6:行程通知模板

  • 7:多图文模板

  • 8:红包模板

  • 9:新闻类模板

  • 10:电商模板

  • 11:16:9图片轮播模板

  • 12:1:1图片轮播模板

  • 13:48:65图片轮播模板

  • 14:视频图文模板

  • 15:长文本模板

  • 16:个性化红包模板

  • 17:电商多商品模板

  • 18:图文视频模板

  • 19:单卡劵模板

  • 20:多卡劵模板

ExtendInfo字段说明

字段

是否必填

类型

描述

字段

是否必填

类型

描述

scene

String

场景,不超过10个字符。

purpose

String

  • 1:商用阶段

  • 2:试商用阶段

说明

试商用阶段,卡片短信文案(标题、正文、按钮文案)中需要携带“测试”字样。

params

String

动参信息定义。最大支持20个动参,动参固定格式为${}$符号不能省略,中间部分为自定义,且需要保证唯一,不能重复,不能带下划线。

示例

[{\"name\":\"${crmShortLink}\",\"type\":1,\"example\":\"y6.ePwql\"}]
  • ${crmShortLink}:动参名定义。

  • type:固定为1。

说明
  • 如果URL带动参,审核人员会对URL进行审核,请确保动参定义和使用格式一致。

  • 当模板元素visible=0时,不可以添加动参。

userExt

Struct

自定义Map结构,示例{"companyName":"阿里云"}。

TemplateContent字段说明

字段

是否必填

类型

描述

字段

是否必填

类型

描述

pages

List<TmpPage>

多页,最多10页。

TmpPage字段说明

字段

是否必填

类型

描述

字段

是否必填

类型

描述

tmpCards

List<TmpCard>

页面元素。

TmpCard字段说明

字段

是否必填

类型

描述

字段

是否必填

类型

描述

type

String

资源类型。

  • TEXT

  • IMAGE

  • VIDEO

  • Button

content

String

文本内容。

说明

资源类型为TEXTButton时为必填。

srcType

Integer

资源类型。

  • 1:资源ID。

  • 2:资源地址。

说明

资源类型为IMAGEVIDEO时为必填。

src

String

素材上传接口返回的媒体资源信息。

说明
  • 资源类型为IMAGEVIDEO时为必填。

  • srcType1时,src填入素材上传接口(GetMediaResourceId)返回的资源ID。

  • srcType2时,src填入资源完成的URL,长度不超过1000个字符。

cover

String

视频封面。

说明
  • 资源类型为VIDEO时为必填。

  • srcType1时,cover填入素材上传接口(GetMediaResourceId)返回的资源ID。

  • srcType2时,cover填入资源完成的URL,长度不超过1000个字符。

actionType

String

action类型。取值:

  • 跳转H5:OPEN_URL

  • 跳转快应用:OPEN_QUICK

  • 跳转APP:OPEN_APP

  • 拉起拨号盘:DIAL_PHONE

  • 新建短信息:OPEN_SMS

  • 打开邮箱:OPEN_EMAIL

  • 新建日程:OPEN_SCHEDULE

  • 位置定位:OPEN_MAP

  • 打开浏览器:OPEN_BROWSER

  • 弹窗:OPEN_POPUP

  • 复制:COPY_PARAMETER

  • 打开大图:VIEW_PIC

positionNumber

Integer

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

action

Object

action对象。不同的actionType具有的action对象不同。

Action字段说明

说明

Action对应的URL地址需为真实可打开链接(包括拼接动参后的URL),以提升审核通过率。

actionType

字段

是否必填

类型

描述

actionType

字段

是否必填

类型

描述

跳转H5:OPEN_URL

target

String

H5访问地址,必须为HTTPS,支持含动态参数,不超过1000个字符。

merchantName

String

访问名称,用于跳转时提示“正在跳转到XXX(商户名称)”,不超过20个字符。

跳转快应用:OPEN_QUICK

target

String

快应用deeplink地址,支持含动态参数,不超过1000个字符。

merchantName

String

访问名称,用于跳转时提示“正在跳转到XXX(商户名称)”,不超过20个字符。

跳转APP:OPEN_APP

target

String

APPdeeplink地址,支持含动态参数,不超过1000个字符。

merchantName

String

问名称,用于跳转时提示“正在跳转到XXX(商户名称)”,不超过20个字符。

packageName

List

包名,不超过50个字符。

floorUrl

String

兜底URL,不填写该字段时会跳转APP应用下载界面,支持快应用deeplinkH5HTTPS网址,不支持含动态参数(APP未安装时使用),不能超过1000个字符。

拉起拨号盘:DIAL_PHONE

target

String

电话号码,不超过13位。

新建短信息:OPEN_SMS

target

String

电话号码,不超过20个字符。

body

String

短信正文,不超过100个字符。

打开邮箱:OPEN_EMAIL

target

String

邮件地址,不超过100个字符。

subject

String

邮件标题,不超过100个字符。

body

String

邮件正文,不超过500个字符。

新建日程:OPEN_SCHEDULE

target

String

日程标题,不超过100个字符。

description

String

日程内容,不超过100个字符。

beginTime

String

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

endTime

String

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

位置定位:OPEN_MAP

target

String

位置名称,不超过100个字符。

address

String

详细地址,不超过100个字符。

longitude

String

位置所在经度,不超过20个字符。

latitude

String

位置所在纬度,不超过20个字符。

打开浏览器:OPEN_BROWSER

target

String

网址必须为HTTPS,支持含动态参数,不超过1000个字符。

merchantName

String

网页名称,用于跳转时提示“正在跳转到XXX(商户名称)”。

弹窗:OPEN_POPUP

target

String

弹窗标题,不超过30个字符。

content

String

弹窗内容,不超过100个字符。

textButton

String

按钮展示文本,不超过12个字符。

mode

String

弹窗模态。

  • 0:模态(默认)

  • 1:非模态(暂不支持)

复制:COPY_PARAMETER

target

String

复制的内容,支持含动态参数,不超过20个字符。

打开大图:VIEW_PIC

target

String

要打开的大图媒体资源ID。

  • 本页导读 (1)
  • Template参数说明
  • ExtendInfo字段说明
  • TemplateContent字段说明
  • TmpPage字段说明
  • TmpCard字段说明
  • Action字段说明
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等