指定模板單發(fā)
提示:
- 驗(yàn)證碼短信,請?jiān)谑謾C(jī)驗(yàn)證環(huán)節(jié),加入圖片驗(yàn)證碼,以免被惡意攻擊。
- 相對于此接口,更推薦使用單條發(fā)送接口,接入更簡單,也更適用于不同系統(tǒng)環(huá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_single_send.json
注意:海外服務(wù)器地址 us.yunpian.com
訪問方式:POST
http 支持:支持 https 與 http 兩種訪問,建議使用 https
請求參數(shù)
參數(shù)名 | 類型 | 是否必須 | 描述 | 示例 |
apikey | string | 是 | 用戶唯一標(biāo)識,在"賬號設(shè)置"-"子帳號管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 接收的手機(jī)號,不需要帶+86 前綴 | 15205201314 |
tpl_id | long | 是 | 模板 id | 100 |
tpl_value | string | 是 | 變量名和變量值對。請先對您的變量名和變量值分別進(jìn)行 urlencode 再傳遞。使用參考:代碼示例 。 注:模板中有變量時(shí),變量名和變量值都不能為空,模板中沒有變量時(shí),賦值 tplvalue="" | 模板: 【云片網(wǎng)】親愛的#name#,您的驗(yàn)證碼是#code#。如非本人操作,請忽略本短信。 最終發(fā)送結(jié)果: 【云片網(wǎng)】親愛的張三,您的驗(yàn)證碼是1234。如非本人操作,請忽略本短信。 tpl_value=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("張三"); 若您直接發(fā)送報(bào)文請求則使用下面這種形式 tpl_value=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("張三")); |
callback_url | string | 否 | 短信發(fā)送后將向這個(gè)地址推送(運(yùn)營商返回的)發(fā)送報(bào)告。 如推送地址固定,建議在"數(shù)據(jù)推送與獲取”做批量設(shè)置。 如后臺已設(shè)置地址,且請求內(nèi)也包含此參數(shù),將以請求內(nèi)地址為準(zhǔn) |
|
extend | string | 否 | 擴(kuò)展號。默認(rèn)不開放,如有需要請聯(lián)系客服申請 | 001 |
uid | string | 否 | 用戶自定義唯一 id。最大長度不超過 256 的字符串。 | 10001 |
java 請求示例
/**指定模版單發(fā)
* @param apikey成功注冊后登錄云片官網(wǎng),進(jìn)入后臺可查看
* @param mobile接收的手機(jī)號,僅支持單號碼發(fā)送
* @param tpl_id發(fā)送的模版id
* @param tpl_value模版內(nèi)容,變量名和變量值對
* @return json格式字符串
*/
public static String tplSingleSend(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_single_send.json", params);
}
php 請求示例
/**指定模版單發(fā)
* @param apikey成功注冊后登錄云片官網(wǎng),進(jìn)入后臺可查看
* @param mobile接收的手機(jī)號,僅支持單號碼發(fā)送
* @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_single_send.json", params);
}
SDK 接入
云片提供多種語言的SDK以供您快速接入 API。
響應(yīng)
名稱 | 類型 | 描述 |
code | integer | 0 代表發(fā)送成功,其他 code 代表出錯,詳細(xì)見"返回值說明"頁面 |
msg | text | 例如""發(fā)送成功"",或者相應(yīng)錯誤信息 |
count | integer | 發(fā)送成功短信的計(jì)費(fèi)條數(shù)(計(jì)費(fèi)條數(shù):70 個(gè)字一條,超出 70 個(gè)字時(shí)按每 67 字一條計(jì)費(fèi)) |
fee | double | 扣費(fèi)金額,單位:元,類型:雙精度浮點(diǎn)型/double |
unit | string | 計(jì)費(fèi)單位;例如:“RMB” |
mobile | string | 發(fā)送手機(jī)號 |
sid | long(64 位) | 短信 id,64 位整型, 對應(yīng) Java 和 C#的 long,不可用 int 解析 |
Json 響應(yīng)示例
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000004",
"sid": 3310228978
}