API 参考

一份约定，覆盖面向客户的全部接口。

面向客户的端点均位于 /api/v1 下。旧的 /api 前缀仍供控制台使用，新的服务端集成应使用带版本号的 base URL。

63 个已文档化的操作8 个资源组OpenAPI 3.1 机器可读的接口约定

身份验证边界

产品集成使用工作区 API 密钥，该密钥还可以读取账户用量、分析数据和 API 密钥元数据。计费变更以及 API 密钥的创建或吊销需要 HTTP-only 浏览器会话，并已作相应标注。

发送、获取、搜索、回复邮件，并查看投递事件。

自动或手动将发出和收到的邮件整理到文件夹中。

借助私有附件存储构建邮件撰写流程。

起草、渲染、测试、版本管理、发布和发送可复用的内容。

开通发信身份，并了解 DNS 验证状态。

创建地址并处理收到的会话。

查看事件、信誉结果和被拦截的收件人。

使用 API 密钥读取账户用量、分析数据和密钥元数据；计费变更以及密钥的创建或吊销需要控制台会话。

JSON 错误使用统一、可预测的封装格式。状态码用于区分无效输入、身份验证、资源不存在、冲突、需要付款、安全拦截和用量限制。

错误响应

{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

这份接口约定由基于日期的 API 版本标识。在同一版本内可以新增向后兼容的字段。破坏性变更需要新的带版本号的基础路径，并提供有文档说明的过渡方案。

服务发现

{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}