API 概覽
概覽
本文檔中列出的所有 API 基礎(chǔ)調(diào)用 URL 是 https://api-v4.mysubmail.com （ 如 API：sms/xsend 實(shí)際請求 URL https://api-v4.mysubmail.com/sms/xsend ） 。
SUBMAIL 支持 json (默認(rèn)) 和 xml 格式，如果你想要 API 返回碼的格式為 xml，請?jiān)?完整 URL 的末尾加上 .xml。
RESTful API
SUBMAIL API 基于 RESTful API 風(fēng)格，它具備完整的 HTTP 請求規(guī)范，多數(shù)的 SUBMAIL API 需采用 POST 方式發(fā)送請求，少量的服務(wù)類 API 使用 GET 方式獲取數(shù)據(jù)。除 API 列舉的請求方式外，其他方法都不被支持。
繼承 RESTful API 風(fēng)格，所有的 SUBMAIL API 都具有 HTTP 返回代碼
2XX- 請求成功。4XX- 請求失敗。（具體出錯(cuò)原因，會在返回?cái)?shù)據(jù)中標(biāo)注錯(cuò)誤代碼和原因）5XX- 服務(wù)器錯(cuò)誤。
參閱 HTTP 狀態(tài)碼 | API 錯(cuò)誤代碼
SUBMAIL WEB API
| 接口 | 用途 |
|---|---|
| SMS/Send - 短信發(fā)送 | 根據(jù)您提交的短信簽名和內(nèi)容，自動創(chuàng)建模板并發(fā)送 |
| SMS/XSend - 短信模板發(fā)送 | 提前創(chuàng)建短信模版，提交模板 ID 發(fā)送 |
| SMS/Multisend - 短信一對多發(fā)送 | SMS/Send 的一對多發(fā)送版本 |
| SMS/MultiXSend - 短信模板一對多發(fā)送 | SMS/XSend 的一對多發(fā)送版本 |
| SMS/BatchSend - 短信批量群發(fā) | SMS/Send 的批量群發(fā)版本 |
| SMS/BatchXSend - 短信批量模板群發(fā) | SMS/XSend 的批量群發(fā)版本 |
| SMS/UnionSend - 國內(nèi)短信與國際短信聯(lián)合發(fā)送 | 結(jié)合了國內(nèi)短信和國際短信的發(fā)送接口，在單一接口實(shí)現(xiàn)全球化短信發(fā)送功能 |
| SMS/Template - 短信模板管理 | 獲取、創(chuàng)建、編輯或刪除您的短信模板 |
| SMS/Reports - 短信分析報(bào)告 | 實(shí)時(shí)查詢短信分析報(bào)告 |
| SMS/Balance - 短信余額查詢 | 實(shí)時(shí)查詢賬戶的短信余額 |
| SMS/Log - 歷史明細(xì)查詢 | 實(shí)時(shí)查詢已發(fā)送的短信歷史明細(xì)數(shù)據(jù) |
| SMS/MO - 短信上行查詢 | 實(shí)時(shí)查詢短信上行回復(fù) |
| AddressBook/SMS/Subscribe - 短信訂閱 | 管理您的短信訂閱用戶 |
| AddressBook/SMS/unsubscribe - 短信退訂 | 管理您的短信退訂用戶 |
| Service/Timestamp - UNIX 時(shí)間戳 | 返回服務(wù)器 UNIX 時(shí)間戳 |
| Service/Status - 返回服務(wù)器狀態(tài) | 返回服務(wù)器狀態(tài)和響應(yīng)時(shí)間 |
創(chuàng)建應(yīng)用
在使用 SUBMAIL API 之前，您需要創(chuàng)建 APP ID 。
點(diǎn)擊了解 創(chuàng)建/管理 APP ID 指南 。