批量發(fā)送接口
提示:
- 因為運營商政策,請先在后臺完成報備簽名、模板及做相關設置(詳見接入引導),再開發(fā) API。
- 不建議使用批量發(fā)送接口發(fā)送驗證碼短信,可能會造成驗證碼發(fā)送延遲。
- 該接口為批量發(fā)送相同內(nèi)容接口,如需批量發(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/batch_send.json`
注意:海外服務器地址 us.yunpian.com
訪問方式:POST
http 支持:支持 https 與 http 兩種訪問,建議使用 https
請求參數(shù)
參數(shù)名 | 類型 | 是否必傳 | 是否默認開放 | 描述 | 示例 |
apikey | string | 是 | 是 | 用戶唯一標識,在"賬號設置"-"子帳號管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 是 | 接收的手機號,發(fā)送多個手機號請以英文逗號分隔,建議單次提交 200 個手機號以內(nèi),不要超過 1000 個,不需要帶+86 前綴 | 單號碼:15205201314 多號碼:15205201314,15205201315 |
text | string | 是 | 是 | 需要發(fā)送的短信內(nèi)容,需要與已審核的短信模板相匹配。 短信內(nèi)容須在最前面攜帶審核通過的簽名。 | 【云片網(wǎng)】您的訂單已經(jīng)發(fā)貨,請注意查收 |
extend | string | 否 | 否 | 下發(fā)號碼擴展號,純數(shù)字 | 001 |
uid | string | 否 | 是 | 該條短信在您業(yè)務系統(tǒng)內(nèi)的 ID,如訂單號或者短信發(fā)送記錄流水號。批量接口同一批短信只能有一個 uid。 | 10001 |
callback_url | string | 否 | 是 | 短信發(fā)送后將向這個地址推送(運營商返回的)發(fā)送報告。 如推送地址固定,建議在"數(shù)據(jù)推送與獲取”做批量設置。 如后臺已設置地址,且請求內(nèi)也包含此參數(shù),將以請求內(nèi)地址為準 |
|
mobile_stat | boolean | 否 | 是 | 若短信中包含云片短鏈接,此參數(shù)傳入 true 將會把短鏈接替換為目標手機號的專屬鏈接,用于統(tǒng)計哪些號碼的機主點擊了短信中的鏈接,可在云片后臺查看。詳情參考短信點擊統(tǒng)計 。 | true |
附注:如需使用"extend"參數(shù),可免費向客服申請。
java 請求示例
/**
* 批量發(fā)送短信,相同內(nèi)容多個號碼,智能匹配短信模板
*
* @param apikey 成功注冊后登錄云片官網(wǎng),進入后臺可查看
* @param text 需要使用已審核通過的模板或者默認模板
* @param mobile 接收的手機號,多個手機號用英文逗號隔開
* @return json格式字符串
*/
public static String batchSend(String apikey, String text, String mobile) {
Map<String, String> params = new HashMap<String, String>();//請求參數(shù)集合
params.put("apikey", apikey);
params.put("text", text);
params.put("mobile", mobile);
return post("https://sms.yunpian.com/v2/sms/batch_send.json", params);//請自行使用post方式請求,可使用Apache HttpClient
}
php 請求示例
/**
* 批量發(fā)送短信,相同內(nèi)容多個號碼,智能匹配短信模板
* @param apikey成功注冊后登錄云片官網(wǎng),進入后臺可查看
* @param text需要使用已審核通過的模板或者默認模板,如果內(nèi)容含有%注意需要是中文全角的
* @param mobile接收的手機號,多個手機號用英文逗號分割
* @return json格式字符串
*/
public function batchSend($apikey, $text, $mobile) {
$param = [
'apikey' => $apikey,
'mobile' => $mobile,
'text' => $text,
];
return post("https://sms.yunpian.com/v2/sms/batch_send.json", params);
}
SDK 接入
云片提供多種語言的SDK以供您快速接入 API。
響應
名稱 | 類型 | 描述 |
total_count | integer | 扣費條數(shù),70 個字一條,超出 70 個字時按每 67 字一條計 |
total_fee | string | 扣費金額,單位:元 |
unit | string | 計費單位;例如:“RMB” |
data | json 數(shù)組 | 參考單個短信發(fā)送返回的數(shù)據(jù) |
Json 響應示例
{
"total_count": 1,
"total_fee": "0.0500",
"unit": "RMB",
"data": [
{
"http_status_code": 400,
"code": 2,
"msg": "請求參數(shù)格式錯誤",
"count": 0,
"fee": 0,
"unit": "RMB",
"mobile": "1234567890123456",
"sid": 0
},
{
"code": 0,
"count": 1,
"fee": 0.05,
"mobile": "15800000000",
"msg": "發(fā)送成功",
"sid": 42007252230,
"unit": "RMB"
}
]
}