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