API 概覽
概覽
本文檔中列出的所有 API 基礎調(diào)用 URL 是 https://api-v4.mysubmail.com （ 如 API：internationalsms/xsend 實際請求 URL https://api-v4.mysubmail.com/internationalsms/xsend ） 。SUBMAIL 支持 json (默認) 和 xml 格式，如果你想要 API 返回碼的格式為 xml，請在 完整 URL 的末尾加上 .xml。
API URL 規(guī)則 ：
https://api-v4.mysubmail.com/[model]/[function].[format]
SUBMAIL 還提供開發(fā)模式的 API，方便開發(fā)者調(diào)試和集成 SUBMAIL 應用。
RESTful API
SUBMAIL API 基于 RESTful API 風格，它具備完整的 HTTP 請求規(guī)范，多數(shù)的 SUBMAIL API 需采用 POST 方式發(fā)送請求，少量的服務類 API 使用 GET 方式獲取數(shù)據(jù)。除 API 列舉的請求方式外，其他方法都不被支持。
繼承 RESTful API 風格，所有的 SUBMAIL API 都具有 HTTP 返回代碼
2XX- 請求成功。4XX- 請求失敗。（具體出錯原因，會在返回數(shù)據(jù)中標注錯誤代碼和原因）5XX- 服務器錯誤。
參閱 HTTP 狀態(tài)碼 | API 錯誤代碼
SUBMAIL WEB API
| 接口 | 用途 |
|---|---|
| InternationalSMS/Send - 國際短信發(fā)送 | 根據(jù)您提交的短信簽名和內(nèi)容，自動創(chuàng)建模板并發(fā)送 |
| InternationalSMS/XSend - 國際短信模板發(fā)送 | 提前創(chuàng)建短信模版，提交模板 ID 發(fā)送 |
| InternationalSMS/MultiXSend - 國際短信模板一對多發(fā)送 | InternationalSMS/XSend 的一對多發(fā)送版本 |
| InternationalSMS/BatchSend - 國際短信批量群發(fā) | InternationalSMS/Send 的批量群發(fā)版本 |
| InternationalSMS/Template - 國際短信模板管理 | 獲取、創(chuàng)建、編輯或刪除您的國際短信模板 |
| Balance/InternationalSMS - 國際短信余額查詢 | 實時查詢賬戶的國際短信余額 |
| Service/Verifyphonenumber - 國際短信歸屬地國家查詢 | 查詢國際手機號碼的歸屬地國家等信息 |
| Service/Timestamp - UNIX 時間戳 | 返回服務器 UNIX 時間戳 |
| Service/Status - 返回服務器狀態(tài) | 返回服務器狀態(tài)和響應時間 |
?
創(chuàng)建應用
在使用 SUBMAIL API 之前，您需要創(chuàng)建 APP ID 。
點擊了解 創(chuàng)建/管理 APP ID 指南 。