API: SMS/BatchXSend - 短信批量模板群發(fā)
版本號 v4.002
更新說明
2024年11月12日
1. 接口新增了對動態(tài)短信簽名的支持,可以通過sms_signature參數(shù)來實現(xiàn)通過一個模板,發(fā)送多種簽名的短信。
概覽
sms/batchxsend
是 SUBMAIL 的批量短信發(fā)送接口。與 sms/xsend 接口相似,在請求中自由提交短信內(nèi)容,to (聯(lián)系人)參數(shù)可以批量提交聯(lián)系人手機號碼(單次請求最大支持 10000 個)大幅提高群發(fā)需求的發(fā)送效率。
URL
https://api-v4.mysubmail.com/sms/batchxsend
支持格式
格式 | URL |
---|---|
json | https://api-v4.mysubmail.com/sms/batchxsend.json (默認(rèn)) |
xml | https://api-v4.mysubmail.com/sms/batchxsend.xml |
yaml | https://api-v4.mysubmail.com/sms/batchxsend.yaml |
http 請求方式
請求方式 | content-type設(shè)置 |
---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機制
sms/batchxsend POST 方法請求參數(shù)
參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用ID |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗證機制 > 授權(quán)和驗證方式。當(dāng)sign_type=normal時signature應(yīng)傳appkey的值。 |
to | string | 必需 | 無 | 收件人手機號碼,多個手機號請使用半角逗號“,”分隔,如“138,139”。單次請求最大上限可提交 10000 個手機號碼 |
project | string | 必需 | 無 | 模版 ID<br/>在 SUBMAIL > Message >項目中查看你所創(chuàng)建的短信模版 ID。請參見獲取項目 ID |
vars | jsonstring | 必需 | 無 | 使用文本變量動態(tài)控制短信中的文本。 參閱 了解如何創(chuàng)建和使用文本變量 |
sms_signature | string | 可選 | 無 | 自定義短信簽名,如果忽略此參數(shù),將使用模板的默認(rèn)簽名作為簽名(此參數(shù)不參與加密計算) |
tag | string | 可選 | 無 | 自定義標(biāo)簽功能,該標(biāo)簽可用作SUBHOOK追蹤 (32 個字符以內(nèi),添加了 tag 參數(shù)的 API 請求,會在所有的 SUBHOOK 事件中攜帶此參數(shù)。(此參數(shù)不參與加密計算) |
timestamp | string | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
sign_version | string | 可選 | 無 | signature加密計算方式 (當(dāng)sign_version傳2時,vars參數(shù)不參與加密計算) |
代碼示例
發(fā)送請求
request: curl -d "appid=***&signature=***&project=xxxx&to=138xxxx,139xxxx" https://api-v4.mysubmail.com/sms/batchxsend
響應(yīng)
{
"status": "success", //請求狀態(tài)
"batchlist": "***", //任務(wù)ID
"total_fee": 2, //總計費條數(shù)
"responses": [
{
"status": "success", //單號狀態(tài)
"to": "138xxxxxx", //號碼
"send_id": "007cb85168d1450e7aca462462ef12b8", //單號 SEND ID
"fee": 1 //單號計費條數(shù)
},
{
"status": "success",
"to": "139xxxxxx",
"send_id": "de4e69f475d24aad62948ac601e1c0ac",
"fee": 1
}
]
}
請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}
錯誤代碼
參閱 API 錯誤代碼