指定模板群發(fā)
提示:1. 不建議使用批量發(fā)送接口發(fā)送驗證碼短信,可能會造成驗證碼發(fā)送延遲。
2. 該接口為指定模板群發(fā)相同內(nèi)容接口,即多個手機號調(diào)用同一模板傳入相同變量,如需群發(fā)不同內(nèi)容,可調(diào)用指定模板單發(fā)接口,通過多線程循環(huán)調(diào)用來實現(xiàn)。
HTTP 頭信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
請求
URL:https://sms.yunpian.com/v2/sms/tpl_batch_send.json
注意:海外服務(wù)器地址 us.yunpian.com
訪問方式:POST
http 支持:支持 https 與 http 兩種訪問,建議使用 https
防騷擾過濾:默認開啟。過濾規(guī)則:同 1 個手機發(fā)相同內(nèi)容,30 秒內(nèi)最多發(fā)送 1 次,5 分鐘內(nèi)最多發(fā)送 3 次。
請求參數(shù)
參數(shù)名 | 類型 | 是否必須 | 描述 | 示例 |
apikey | string | 是 | 用戶唯一標識,在"賬號設(shè)置"-"子帳號管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 接收的手機號,發(fā)送多個手機號請以英文逗號分隔,建議單次提交 200 個手機號以內(nèi),不要超過 1000 個,不需要帶+86 前綴 | 單號碼:15205201314 多號碼:15205201314,15205201315 |
tpl_id | long | 是 | 模板 id | 100 |
tpl_value | string | 是 | 變量名和變量值對。請先對您的變量名和變量值分別進行 urlencode 再傳遞。使用參考:代碼示例 。 注:模板中有變量時,變量名和變量值都不能為空,模板中沒有變量時,賦值 tplvalue="" | 模板:【云片網(wǎng)】親愛的#name#,您的驗證碼是#code#。如非本人操作,請忽略本短信。 最終發(fā)送結(jié)果: 【云片網(wǎng)】親愛的張三,您的驗證碼是1234。如非本人操作,請忽略本短信。 tpl_value=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("張三"); 若您直接發(fā)送報文請求則使用下面這種形式 tpl_value=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("張三")); |
callback_url | string | 否 | 短信發(fā)送后將向這個地址推送(運營商返回的)發(fā)送報告。 如推送地址固定,建議在"數(shù)據(jù)推送與獲取”做批量設(shè)置。 如后臺已設(shè)置地址,且請求內(nèi)也包含此參數(shù),將以請求內(nèi)地址為準 |
|
extend | string | 否 | 擴展號。默認不開放,如有需要請聯(lián)系客服申請 | 001 |
uid | string | 否 | 用戶自定義唯一 id。最大長度不超過 256 的字符串。 | 10001 |
java 請求示例
/**
* 指定模版群發(fā)
* @param apikey成功注冊后登錄云片官網(wǎng),進入后臺可查看
* @param mobile接收的手機號,多個手機號用英文逗號分割
* @param tpl_id發(fā)送的模版id
* @param tpl_value模版內(nèi)容,變量名和變量值對,如果內(nèi)容含有%注意需要是中文全角的
* @return json格式字符串
*/
public static String tplBatchSend(String apikey, String mobile, long tpl_id) {
Map<String, String> params = new HashMap<String, String>();
params.put("apikey", apikey);
params.put("mobile", mobile);
params.put("tpl_id", String.valueOf(tpl_id));
params.put("tpl_value",URLEncoder.encode("#code#", ENCODING) + "=" + URLEncoder.encode("1234", ENCODING) + "&" + URLEncoder.encode("#min#", ENCODING) + "=" + URLEncoder.encode("5",ENCODING));
return post("https://sms.yunpian.com/v2/sms/tpl_batch_send.json", params);
}
php 請求示例
/**指定模板群發(fā)
* @param apikey成功注冊后登錄云片官網(wǎng),進入后臺可查看
* @param mobile接收的手機號,多個手機號用英文逗號分割
* @param tpl_id發(fā)送的模版id
* @param tpl_value模版內(nèi)容,變量名和變量值對,如果內(nèi)容含有%注意需要是中文全角的
* @return json格式字符串
*/
public function tplSingleSend( $apikey , $mobile , $tplId) {
$param = [
'apikey' => $apikey,
'mobile' => $mobile,
'tpl_id' => $tplId,
'tpl_value' =>('#time#').'=2018-10-11 12:10:11'.'&'.('#content#').'='.urlencode('今年獲取30%的紅利')
];
return post("https://sms.yunpian.com/v2/sms/tpl_batch_send.json", params);
}
SDK 接入
云片提供多種語言的SDK以供您快速接入 API。
Json 響應(yīng)示例
{
"total_count": 6,
"total_fee": "0.3000",
"unit": "RMB",
"data": [
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000004",
"sid": 3310228978
},
{
"code": 2,
"msg": "請求參數(shù)格式錯誤",
"count": "0",
"fee": "0",
"unit": "RMB",
"mobile": "123321",
"sid": "0"
},
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000005",
"sid": 3310228970
},
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000006",
"sid": 3310228972
},
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000007",
"sid": 3310228974
},
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000005",
"sid": 3310228976
},
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000005",
"sid": 3310228980
},
{
"code": 2,
"msg": "請求參數(shù)格式錯誤",
"count": "0",
"fee": "0",
"unit": "RMB",
"mobile": "123321",
"sid": "0"
}
]
}