API: SMS/Send - 短信發(fā)送
概覽
sms/send 是 SUBMAIL 的短信 API。 sms/send API 提供強大的短信發(fā)送功能, 并允許用戶自定義短信簽名及正文，無需提前創(chuàng)建模板，SUBMAIL 會根據(jù)您提交的短信簽名和內(nèi)容，自動創(chuàng)建模板并發(fā)送。
URL
https://api-v4.mysubmail.com/sms/send
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/send.json（默認） |
xml | https://api-v4.mysubmail.com/sms/send.xml |
yaml | https://api-v4.mysubmail.com/sms/send.yaml |
http 請求方式
| 請求方式 | content-type設置 |
|---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
get |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機制
請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的短信應用ID |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API授權(quán)與驗證機制 > 授權(quán)和驗證方式。當sign_type=normal時signature應傳appkey的值。 |
to | string | 必需 | 無 | 收件人手機號碼，該API僅支持一對一模式（即單條API請求僅能發(fā)送一個聯(lián)系人），該參數(shù)現(xiàn)在僅能提交一個位聯(lián)系人。 |
content | string | 必需 | 無 | 短信正文 （正文中必須提交有效的短信簽名，且您的短信簽名必須放在短信的最前端，e.g.【SUBMAIL】您的短信驗證碼：4438，請在10分鐘內(nèi)輸入。 content 參數(shù)將會與您賬戶中的短信模板進行匹配，如無匹配 API會創(chuàng)建一個短信模板并提交到人工審核，審核通過后下次提交相似短信（內(nèi)容達到一定匹配度）則不會觸發(fā)人工審核直接進行下發(fā)，如審核失敗則第二次請求返回 420 錯誤，審核失敗會觸發(fā)SUBHOOK中模板template_reject事件請將短信正文控制在 1000 個字符以內(nèi)。） |
tag | string | 可選 | 無 | 自定義標簽功能，該標簽可用作SUBHOOK追蹤 （32 個字符以內(nèi)，添加了 tag 參數(shù)的 API 請求，會在所有的 SUBHOOK 事件中攜帶此參數(shù)。tag參數(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加密計算方式 (當sign_version傳2時，content參數(shù)不參與加密計算) |
代碼示例
發(fā)送一封測試短信
POST URL
https://api-v4.mysubmail.com/sms/sendPOST DATA
appid=your_app_id
&to=138xxxxxxxx
&content=【SUBMAIL】您的短信驗證碼：4438，請在10分鐘內(nèi)輸入。
&signature=your_app_key返回
{
"status": "success", //請求狀態(tài)
"send_id": "893c91d9bfaa433f6952b2902546a8ed", //唯一send_id
"fee": 1 //計費條數(shù)
}使用 CURL 發(fā)送一封測試短信
發(fā)送 CURL
curl -d 'appid=your_app_id&to=138xxxxxxxx&content=【SUBMAIL】您的短信驗證碼：4438，請在10分鐘內(nèi)輸入。&signature=your_app_key' https://api-v4.mysubmail.com/sms/send.json返回值
請求成功
{
"status": "success", //請求狀態(tài)
"send_id": "893c91d9bfaa433f6952b2902546a8ed", //唯一send_id
"fee": 1 //計費條數(shù)
}請求失敗
{
"status":"error", //請求狀態(tài)
"code":"1xx", //失敗碼
"msg":"error sms" //失敗信息描述
}