國(guó)際短信單條發(fā)送接口
提示:
- 因?yàn)檫\(yùn)營(yíng)商政策,請(qǐng)先在后臺(tái)完成模板報(bào)備及做相關(guān)設(shè)置(詳見接入引導(dǎo)),再開發(fā) API;
- 美國(guó)、加拿大、臺(tái)灣、馬來西亞等地報(bào)備需要2-5個(gè)工作日。
HTTP 頭信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
請(qǐng)求
URL:https://sms.yunpian.com/v2/sms/single_send.json
注意:海外服務(wù)器地址 us.yunpian.com
訪問方式:POST
支持 https 與 http 兩種訪問,建議使用 https
附注:國(guó)際短信接口每次調(diào)用只能發(fā)送一條短信,如需發(fā)送多條,請(qǐng)多次調(diào)用。
請(qǐng)求參數(shù)
參數(shù)名 | 類型 | 是否必傳 | 是否默認(rèn)開放 | 描述 | 示例 |
apikey | String | 是 | 是 | 用戶唯一標(biāo)識(shí),在"賬號(hào)設(shè)置"-"子帳號(hào)管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | String | 是 | 是 | 接收的手機(jī)號(hào),僅支持單號(hào)碼發(fā)送; 國(guó)際號(hào)碼需包含國(guó)際地區(qū)前綴號(hào)碼 | +93701234567 |
text | String | 是 | 是 | 發(fā)送的短信內(nèi)容需要與已審核的短信模板相匹配。新增模板可登錄后臺(tái)國(guó)際短信-模板報(bào)備頁面 | 【云片網(wǎng)】您的驗(yàn)證碼是 1234 |
uid | String | 否 | 是 | 該條短信在您業(yè)務(wù)系統(tǒng)內(nèi)的 ID,如訂單號(hào)或者短信發(fā)送記錄流水號(hào)。 | 10001 |
callback_url | String | 否 | 是 | 短信發(fā)送后將向這個(gè)地址推送(運(yùn)營(yíng)商返回的)狀態(tài)報(bào)告。 如推送地址固定,建議在"數(shù)據(jù)推送與獲取”做批量設(shè)置。 如后臺(tái)已設(shè)置地址,且請(qǐng)求內(nèi)也包含此參數(shù),將以請(qǐng)求內(nèi)地址為準(zhǔn) |
|
register | Boolean | 否 | 否 | 是否為注冊(cè)驗(yàn)證碼短信,如果傳入 true,則該條短信作為注冊(cè)驗(yàn)證碼短信統(tǒng)計(jì)注冊(cè)成功率,需聯(lián)系客服開通。 |
|
附注:
- 如需使用"uid"參數(shù),可免費(fèi)向客服申請(qǐng)。
- 請(qǐng)求必須以 URL 編碼
java 請(qǐng)求示例
/**單條短信發(fā)送,智能匹配短信模板
* @param apikey成功注冊(cè)后登錄云片官網(wǎng),進(jìn)入后臺(tái)可查看
* @param text需要使用已審核通過的模板或者默認(rèn)模板
* @param mobile接收的手機(jī)號(hào),僅支持單號(hào)碼發(fā)送
* @return json格式字符串
*/
public static String singleSend(String apikey, String text, String mobile) {
Map<String, String> params = new HashMap<String, String>();//請(qǐng)求參數(shù)集合
params.put("apikey", apikey);
params.put("text", text);
params.put("mobile", mobile);
return post("https://sms.yunpian.com/v2/sms/single_send.json", params);//請(qǐng)自行使用post方式請(qǐng)求,可使用Apache HttpClient
}
php 請(qǐng)求示例
/**單條短信發(fā)送,智能匹配短信模板
* @param apikey成功注冊(cè)后登錄云片官網(wǎng),進(jìn)入后臺(tái)可查看
* @param text需要使用已審核通過的模板或者默認(rèn)模板,如果內(nèi)容含有%注意需要是中文全角的
* @param mobile接收的手機(jī)號(hào),僅支持單號(hào)碼發(fā)送
* @return json格式字符串
*/
public function singleSend($apikey, $text, $mobile) {
$param = [
'apikey' => $apikey,
'mobile' => $mobile,
'text' => $text,
];
return post("https://sms.yunpian.com/v2/sms/single_send.json", params);
}
SDK 接入
云片提供多種語言的SDK以供您快速接入 API。
響應(yīng)
名稱 | 類型 | 描述 |
code | integer | 0 代表發(fā)送成功,其他 code 代表出錯(cuò),詳細(xì)見"返回值說明"頁面 |
msg | text | 例如""發(fā)送成功"",或者相應(yīng)錯(cuò)誤信息 |
count | integer | 發(fā)送成功短信的計(jì)費(fèi)條數(shù) 1、純英文:160字內(nèi)計(jì)1條短信費(fèi),超過160字以153字每條計(jì)費(fèi),特殊字符|^€[]~\算兩個(gè)字。 2、非純英文:70字內(nèi)計(jì)1條短信費(fèi),超過70字以67字每條計(jì)費(fèi)。 3、如短信中含變量的,以實(shí)際發(fā)送短信字?jǐn)?shù)為準(zhǔn) |
fee | double | 扣費(fèi)金額,單位:元,類型:雙精度浮點(diǎn)型/double |
unit | string | 計(jì)費(fèi)單位;例如:“RMB” |
mobile | string | 發(fā)送手機(jī)號(hào) |
sid | long(64 位) | 短信 id,64 位整型, 對(duì)應(yīng) Java 和 C#的 long,不可用 int 解析 |
Json 返回示例
{
"code": 0,
"msg": "發(fā)送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "+93701234567",
"sid": 3310228982
}