文本变量 @var(key_name)
概览
文本变量可以动态的控制短信或短信模板中的文本内容。
适用 API
| 接口 | 描述 |
|---|---|
| Internationalsms/xsend | 短信 API |
| internationalsms/multixsend | 短信群发API |
格式
@var(自定义的变量名)
创建变量
在 SUBMAIL EDITOR 中创建短信模板，在需要动态控制的文本位置键入 @var(key_name)，以来实现对短信内容的动态控制。
使用变量
在你使用 API 发送时，请以 json 字符串（key:value）方式连接你的变量 e.g. {”key”:”value”,”key”:”value”}，并将此字符串放在 vars 参数中提交。
注：例中的 key 表示你设定的变量名，value 表示你想替换此变量的文本
例：如果你在短信模板中创建了 2 个变量，分别为 @var(code) , @var(time) ，如下：
在 vars 参数中将 vars={"code":"352839","time":"2分钟"} 提交至 SUBMAIL，用户收到的短信如下：
请注意：vars 参数要求严格的 JSON 格式，以下是将参数转换为 JSON 格式的注意事项
- json 字符串必须以双引号包含
- json 字符串必须是 utf8 编码
- 不能有多余的逗号 如：[1,2,]
- json 字符串首尾必须被大括号{}包含
PS:大多数的语言都有专属的JSON解析器（ ENCODING 和 DECODEING 方法）。如 PHP，首先将需要的变量以数组形式（如 $var\[‘key’\]=value）创建后，使用 json_encode($var)方法创建 JSON 字符串；