API 概覽
概覽
本文檔中列出的所有 API 基礎調(diào)用 URL 是 https://api-v4.mysubmail.com
( 如 API:mail/xsend
實際請求 URL https://api-v4.mysubmail.com/mail/xsend
) 。
SUBMAIL 支持 json
(默認) 和 xml
格式,如果你想要 API 返回碼的格式為 xml
,請在 完整 URL 的末尾加上 .xml
。
API URL 規(guī)則 :
https://api-v4.mysubmail.com/[model]/[function].[format]
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
- mail/send ( 基礎郵件發(fā)送 API )
- mail/xsend( 增強的郵件發(fā)送 API )
- addressbook/mail/subscribe ( 郵件訂閱 API )
- addressbook/mail/unsubscribe ( 郵件退訂 API )
- service/timestamp ( 服務器 UNIX 時間戳 )
- service/status (服務器狀態(tài))
SMTP
創(chuàng)建應用
在使用 SUBMAIL API 之前,您需要創(chuàng)建 AppID 。
點擊了解 創(chuàng)建/管理 AppID 指南 。