API: SMS/BatchSend - 短信批量群發(fā)
概覽
sms/batchsend 是 SUBMAIL 的批量短信發(fā)送接口。與 sms/send 接口相似，在請(qǐng)求中自由提交短信內(nèi)容，to （聯(lián)系人）參數(shù)可以批量提交聯(lián)系人手機(jī)號(hào)碼（單次請(qǐng)求最大支持 10000 個(gè)）大幅提高群發(fā)需求的發(fā)送效率。
URL
https://api-v4.mysubmail.com/sms/batchsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/batchsend.json （默認(rèn)） |
xml | https://api-v4.mysubmail.com/sms/batchsend.xml |
yaml | https://api-v4.mysubmail.com/sms/batchsend.yaml |
http 請(qǐng)求方式
| 請(qǐng)求方式 | content-type 支持 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
sms/batchsend 方法請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用ID |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式。當(dāng)sign_type=normal時(shí)signature應(yīng)傳appkey的值。 |
to | string | 必需 | 無 | 收件人手機(jī)號(hào)碼，多個(gè)手機(jī)號(hào)請(qǐng)使用半角逗號(hào)“,”分隔，如“138,139”。單次請(qǐng)求最大上限可提交 10000 個(gè)手機(jī)號(hào)碼 |
content | string | 必需 | 無 | 短信正文 （正文中必須提交有效的短信簽名，且您的短信簽名必須放在短信的最前端，e.g.【SUBMAIL】您的短信驗(yàn)證碼：4438，請(qǐng)?jiān)?0分鐘內(nèi)輸入。 content 參數(shù)將會(huì)與您賬戶中的短信模板進(jìn)行匹配，如無匹配 API會(huì)創(chuàng)建一個(gè)短信模板并提交到人工審核，審核通過后下次提交相似短信（內(nèi)容達(dá)到一定匹配度）則不會(huì)觸發(fā)人工審核直接進(jìn)行下發(fā)，如審核失敗則第二次請(qǐng)求返回 420 錯(cuò)誤，審核失敗會(huì)觸發(fā) SUBHOOK 中模板 template_reject 事件請(qǐng)將短信正文控制在 1000 個(gè)字符以內(nèi)。） |
tag | string | 可選 | 無 | 自定義標(biāo)簽功能，該標(biāo)簽可用作 SUBHOOK 追蹤 （32 個(gè)字符以內(nèi)，添加了 tag 參數(shù)的 API 請(qǐng)求，會(huì)在所有的 SUBHOOK 事件中攜帶此參數(shù)。tag 參數(shù)不參加加密計(jì)算） |
timestamp | string | 可選 | 無 | 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > Timestamp UNIX 時(shí)間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
sign_version | string | 可選 | 無 | signature加密計(jì)算方式 (當(dāng)sign_version傳2時(shí)，content參數(shù)不參與加密計(jì)算) |
代碼示例
發(fā)送請(qǐng)求
request: curl -d "appid=***&signature=***&content=【簽名】測(cè)試&to=138xxxx,139xxxx" https://api-v4.mysubmail.com/sms/batchsend響應(yīng)
{
"status": "success", //請(qǐng)求狀態(tài)
"batchlist": "***", //任務(wù)ID
"total_fee": 2, //總計(jì)費(fèi)條數(shù)
"responses": [
{
"status": "success", //單號(hào)狀態(tài)
"to": "138xxxxxx", //號(hào)碼
"send_id": "007cb85168d1450e7aca462462ef12b8", //單號(hào) SEND ID
"fee": 1 //單號(hào)計(jì)費(fèi)條數(shù)
},
{
"status": "success",
"to": "139xxxxxx",
"send_id": "de4e69f475d24aad62948ac601e1c0ac",
"fee": 1
}
]
}請(qǐng)求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}