文本變量 @var(key_name)
概覽
文本變量可以動(dòng)態(tài)的控制短信或短信模板中的文本內(nèi)容。
適用 API
| 接口 | 描述 |
|---|---|
| message/xsend | 模板發(fā)送 API |
| message/multixsend | 模板一對(duì)多發(fā)送 API |
| message/multisend | 一對(duì)多發(fā)送 API |
格式
@var(自定義的變量名)
創(chuàng)建變量
在 SUBMAIL EDITOR 中創(chuàng)建短信模板，在需要?jiǎng)討B(tài)控制的文本位置鍵入 @var(key_name)，以來(lái)實(shí)現(xiàn)對(duì)短信內(nèi)容的動(dòng)態(tài)控制。
使用變量
在你使用 API 發(fā)送時(shí)，請(qǐng)以 json 字符串{key:value}方式連接你的變量 e.g. {”key1”:”value1”,”key2”:”value2”}，并將此字符串放在 vars 參數(shù)中提交。
注：例中的 key 表示你設(shè)定的變量名，value 表示你想替換此變量的文本
例：如果你在短信模板中創(chuàng)建了 2 個(gè)變量，分別為 @var(code) , @var(time) ，如下：
在 vars 參數(shù)中將 vars={"code":"352839","time":"2分鐘"} 提交至 SUBMAIL，用戶收到的短信如下：
請(qǐng)注意：vars 參數(shù)要求嚴(yán)格的 JSON 格式，以下是將參數(shù)轉(zhuǎn)換為 JSON 格式的注意事項(xiàng)
- json 字符串必須以雙引號(hào)包含
- json 字符串必須是 utf8 編碼
- 不能有多余的逗號(hào) 如：[1,2,]
- json 字符串首尾必須被大括號(hào){}包含
PS:大多數(shù)的語(yǔ)言都有專(zhuān)屬的JSON解析器（ ENCODING 和 DECODEING 方法）。如 PHP，首先將需要的變量以數(shù)組形式（如 $var\[‘key’\]=value）創(chuàng)建后，使用 json_encode($var)方法創(chuàng)建 JSON 字符串；