API: Message/send

概覽

一分鐘快速整合簡訊驗證碼[圖文教程]

message/send 是 SUBMAIL 的簡訊 API。 message/send API 提供強大的簡訊傳送功能, 並允許使用者自定義簡訊簽名及正文，無需提前建立模板，SUBMAIL 會根據您提交的簡訊簽名和內容，自動建立模板併發送。

URL

<主> https://api.mysubmail.com/message/send

<備> https://api.submail.cn/message/send

支援格式

格式URLjsonhttps://api.mysubmail.com/message/send.json （預設）xmlhttps://api.mysubmail.com/message/send.xml

http 請求方式

請求方式content-type設定http postmultipart/form-data、x-www-form-urlencoded、application/json

是否需要授權

是

參閱 API 授權和驗證機制

請求引數

引數型別必需/可選預設描述appidstring必需無在 SUBMAIL 應用整合中建立的簡訊應用IDtostring必需無收件人手機號碼，該API僅支援一對一模式（即單條API請求僅能傳送一個聯絡人），該引數現在僅能提交一個位聯絡人。contentstring必需無簡訊正文（正文中必須提交有效的簡訊簽名，且您的簡訊簽名必須放在簡訊的最前端，e.g.【SUBMAIL】您的簡訊驗證碼：4438，請在10分鐘內輸入。content 引數將會與您賬戶中的簡訊模板進行匹配，如無匹配 API會建立一個簡訊模板並提交到人工稽核，稽核通過後下次提交相似簡訊（內容達到一定匹配度）則不會觸發人工稽核直接進行下發，如稽核失敗則第二次請求返回 420 錯誤，稽核失敗會觸發SUBHOOK中模板template_reject事件請將簡訊正文控制在 500 個字元以內。）tagstring可選無自定義標籤功能，該標籤可用作SUBHOOK追蹤（32 個字元以內，添加了 tag 引數的 API 請求，會在所有的 SUBHOOK 事件中攜帶此引數。）timestampUNIX 時間戳可選無參閱 API 授權與驗證機制 > Timestamp UNIX 時間戳sign_typestring可選normalAPI 授權模式（ md5 or sha1 or normal ）參閱 API 授權與驗證機制 > 授權和驗證方式sign_versionstring可選無signature加密計算方式(當sign_version傳2時，content引數不參與加密計算)signaturestring必需無應用密匙或數字簽名參閱 API授權與驗證機制 > 授權和驗證方式

程式碼示例

傳送一封測試簡訊

POST URL

https://api.mysubmail.com/message/send.json

POST DATA

appid=your_app_id &to=138xxxxxxxx &content=【SUBMAIL】您的簡訊驗證碼：4438，請在10分鐘內輸入。 &signature=your_app_key

返回

{ "status": "success", "send_id": "c2f0e679ad8dxxxxxf6cb71bf2925665e0", "fee": 1, "sms_credits": "21129", "transactional_sms_credits": "0" }

使用 CURL 傳送一封測試簡訊

傳送 CURL

curl -d "appid=your_app_id&to=138xxxxxxxx&content=【SUBMAIL】您的簡訊驗證碼：4438，請在10分鐘內輸入。&signature=your_app_key" https://api.mysubmail.com/message/send.json

返回

{ "status": "success", "send_id": "c2f0e679ad8dxxxxxf6cb71bf2925665e0", "fee": 1, "sms_credits": "21129", "transactional_sms_credits": "0" }

返回值

請求成功

{ "status": "success", "send_id": "c2f0e679ad8dxxxxxf6cb71bf2925665e0", "fee": 1, "sms_credits": "21129", "transactional_sms_credits": "0" }

請求失敗

{ "status":"error", "code":"1xx", "msg":"error message" }

錯誤程式碼

參閱 API 錯誤程式碼