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

Template字段说明

字段 是否必填 类型 描述
extendInfo 是 Struct 扩展字段。
templateContent 是 Struct 卡片短信模板内容。
cardSignName 是 String 卡片短信模板签名，生成短链时需要。
cardType 是 Integer 卡片模板类型。取值：
  • 横滑类1模板
  • 横滑类2模板
  • 通知类模板
  • 视频类模板
  • 图文类模板
  • 行程类模板
  • 多图文类模板
  • 红包类模板
  • 新闻类模板
  • 电商类模板
  • 16:9图片轮播类模板
  • 1:1图片轮播类模板
  • 48:65图片轮播类模板
  • 视频类图文模板
  • 长文本类模板
  • 个性化红包类模板
  • 电商多商品类模板
  • 图文视频类模板
  • 单卡劵类模板
  • 多卡劵类模板

ExtendInfo字段说明

字段 是否必填 类型 描述
scene 是 String 场景，不超过10个字符。
purpose 是 String
  • 1：商用阶段
  • 2：试商用阶段
说明 试商用阶段，卡片短信文案（标题、正文、按钮文案）中需要携带“测试”字样。
params 否 String 动参信息定义。

最大支持20个动参，动参${}为固定格式，中间部分为自定义，保证唯一，不能重复，不能带下划线。

示例：

[{\"name\":\"${crmShortLink}\",\"type\":1,\"example\":\"y6.ePwql\"}]

${crmShortLink}：动参名定义；type：固定为1。

如果URL带动参，审核人员会对URL进行审核，请确保动参定义和使用格式一致。
userExt 否 Struct 自定义Map结构，示例：{"companyName":"阿里云"}。

TemplateContent Struct字段说明

字段 是否必填 类型 描述
pages 是 List<TmpPage> 多页，最多10页。

TmpPage字段说明

字段 是否必填 类型 描述
tmpCards 是 List<TmpCard> 页面元素。

TmpCard字段说明

字段 是否必填 类型 描述
type 是 String 资源类型。
  • TEXT
  • IMAGE
  • VIDEO
  • Button
content 是 String 文本内容。
说明 资源类型为TEXT或Button时为必填。
srcType 是 Integer 资源类型。
  • 1：资源ID。
  • 2：资源地址。
说明 资源类型为IMAGE或VIDEO时为必填。
src 是 String 素材上传接口返回的媒体资源信息。
说明
  • 资源类型为IMAGE或VIDEO时为必填。
  • srcType为1时，src填入素材上传接口返回的资源ID。
  • srcType为2时，src填入资源完成的URL，长度不超过1000个字符。
cover 是 String 视频封面。
说明
  • 资源类型为VIDEO时为必填。
  • srcType为1时，cover填入素材上传接口返回的资源ID。
  • srcType为2时，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 是 Map action对象。不同的actionType具有的action对象不同。

Action字段说明

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 APP的deeplink地址，支持含动态参数，不超过1000个字符。
merchantName 是 String 问名称，用于跳转时提示“正在跳转到XXX（商户名称）”，不超过20个字符。
packageName 是 List 包名，不超过50个字符。
floorUrl 否 String 兜底URL，不填写该字段时会跳转APP应用下载界面，支持快应用deeplink或H5的HTTPS网址，不支持含动态参数（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。