API 概览

概览

本文档中列出的所有 API 基础调用 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 规则 ：

https://api-v4.mysubmail.com/[model]/[function].[format]

RESTful API

SUBMAIL API 基于 RESTful API 风格，它具备完整的 HTTP 请求规范，多数的 SUBMAIL API 需采用 POST 方式发送请求，少量的服务类 API 使用 GET 方式获取数据。除 API 列举的请求方式外，其他方法都不被支持。

继承 RESTful API 风格，所有的 SUBMAIL API 都具有 HTTP 返回代码

• 2XX - 请求成功。
• 4XX - 请求失败。（具体出错原因，会在返回数据中标注错误代码和原因）
• 5XX - 服务器错误。

参阅 HTTP 状态码 | API 错误代码

SUBMAIL WEB API

• mail/send ( 基础邮件发送 API )
• mail/xsend( 增强的邮件发送 API )
• addressbook/mail/subscribe （ 邮件订阅 API ）
• addressbook/mail/unsubscribe （ 邮件退订 API ）
• service/timestamp ( 服务器 UNIX 时间戳 )
• service/status （服务器状态）

SMTP

• SMTP
• SMTP API

创建应用

在使用 SUBMAIL API 之前，您需要创建 AppID 。

点击了解 创建/管理 AppID 指南 。