消息&短信 MSGSMS-模板和变量规范:变量规范

时间:2023-11-01 16:21:56

变量规范

每个模板中最多包含20个变量,不支持连续变量。(变量间包含文字则为不连续变量)

:如果需要扩展变量长度,请在申请短信模板时,详细备注说明业务使用场景。

模板内容中的变量格式规范如下:

两种变量格式等效,系统按${}解析识别变量,大括号中的序号标识/类型标识只是方便查阅,并无实际作用。需要为各变量设置变量属性,才能让相应变量规范生效。

变量格式

填写示例

说明

按序号标识

${1}、${2}、...、${20}

中间数字应代表变量在模板内容中的位置顺序。即${1}表示模板内容中的第一个变量,${2}表示模板内容中的第二个变量,以此类推。

说明:

特殊内容(如网址、手机号等)不允许设置局部变量,如www.${1}.cn、186${2}1234等。

按类型标识

${PHONE}、${CHARDIGIT}、${DATETIME}、${MONEY}、${TEXT}

中间字符表示变量类型,各变量有默认长度限制,不支持自定义设置。

当模板内容中设置了变量时,必须指定变量属性。变量属性的设置规范如下,小数点、字母、汉字、空格以及其他符号按1个变量长度计算。

变量属性

变量类型

规范

电话号码

PHONE

长度限制:1-15个字符。

可以传入手机号、座机号、95或400、800电话等。

其他号码(如验证码、订单号、密码等)

CHARDIGIT

长度限制:1-20个字符。

主要用途为验证码、订单号,密码、随机秘钥等。

  • 不允许出现手机号、QQ号、微信号、URL等联系方式。
  • 仅支持大小写字母和数字组合。

时间

DATETIME

长度限制:1-20个字符。

需要符合时间的表达方式,格式示例如下:

  • 日期:yyyyMMdd、yyyy-MM-dd、yyyy/MM/dd、yyyy年mm月dd日。
  • 时间:HH:mm:ss、HH:mm、HH点mm分、HH点mm。

如果需要同时指定日期和时间,请在模板中填充两个变量,一个变量传入日期,另一个变量传入时间。

  • 短信内容示例:

    温馨提醒:2020-01-10 19:00-21:00的会议即将开始,请您准时参加。

  • 模板示例:

    温馨提醒:${1} ${2}-${3}的会议即将开始,请您准时参加。

金额

MONEY

长度限制:1-20个字符。

  • 仅支持传入能够正常表达金额的数字、小数点或中文,例如壹、贰、叁、肆等。
  • 支持传入IP地址,例如:10.1.1.10。
说明:

¥$等货币符号需要放在模板中,不支持变量传入。

其他(如名称、账号、地址等)

TEXT

长度限制:1-20个字符。

  • 可以设置为公司/产品/地址/姓名/内容/账号/会员名等。
  • 不允许出现QQ号/微信号(公众号)/手机号/网址/座机号等联系方式。如果确有需要,请将联系方式放入模板中。
  • 不允许在传入值中携带“.”、“。”、“{”或“}”。否则,可能导致模板变量解析异常。
  • 不允许在传入值中携带“.”,即不支持传入IP地址,如变量取值为IP地址,请申请模板时选择变量属性为“金额”。
support.huaweicloud.com/msgsms_faq/sms_faq_0003.html