-
1 # SUBMAIL何凍凍
-
2 # wujing11hao
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 事件中攜帶此引數。tag引數不參加加密計算)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 錯誤程式碼
回覆列表
以SUBMAIL為例,在進行以下步驟前,請先完成您的賬戶配置並認證。
步驟一、前往-》開發者 -》SDK開發包下載頁面,下載對應語言的SDK開發包。SUBMAIL 提供多達9種語言的開發包,SDK 集成了 SUBMAIL 的API請求方法,並將API中的引數進行封裝,開發者僅需下載對應語言的開發包即可快速配置簡訊服務。
步驟二、建立 APPIDSUBMAIL的API請求需要應用ID和金鑰用於 API 身份鑑權,建立應用的步驟如下:
1.前往-》建立/管理 APPID -》建立 APPID -》在彈出框中輸入 APPID 名稱,即完成 APPID 的建立。
2. 將已建立的 APPID 和 APPKEY 複製到開發包的配置檔案內
以 PHP SDK為例,請將應用頁面的 APPID 和 APPKEY 複製到 app_config.php 檔案內的對應位置,如下圖:
各語言的配置檔案對應清單:
PHP => /path/to/app_config.phpJAVA => /path/to/app_config.propertiesC# => /path/to/AppConfigs.csPYTHON => /path/to/app_configs.pyRUBY => /path/to/submaildemo.rbGO => /path/to/main.goOBJECTIVE-C => /path/to/config/SMConfig.hSWIFT => /path/to/config/Config.swiftNode.js => /path/to/config.js複製/粘貼後儲存該配置檔案,進行下一步;
三、SDK介面呼叫本文以 PHP 開發包為例,其他語言可作為參考,具體檔案和目錄可能略有不同
開啟下載的開發包中 DEMO 目錄下的 message_send_demo.php 檔案;請參考message/send,https://www.mysubmail.com/chs/documents/developer/YPWD84在$submail->setTo("186********");引數中填寫接收者的手機號碼;在$submail->setcontent("*********")引數中填寫簡訊內容;完整的程式碼如圖所示:
儲存該demo檔案,執行即可傳送該簡訊。
以上程式碼輸出的簡訊為:【SUBMAIL】您的驗證碼:4438,請在10分鐘內輸入。