限时优惠：首次付款享 30% 折扣。
InboxWarm.ai LogoInboxWarm
返回 API 概览

InboxWarm API 文档

InboxWarm REST API 的参考文档。请配合 InboxWarm API Postman 集合一起使用。

本页内容
基础 URL身份验证速率限制错误端点索引

系统

GET健康检查GET速率限制状态

电子邮件账户

GET列出电子邮件账户POST连接电子邮件账户POST批量连接电子邮件账户POST断开电子邮件账户DELETE删除电子邮件账户POST批量删除电子邮件账户GET获取电子邮件账户状态POST批量电子邮件账户状态

预热

GET获取预热设置PATCH更新预热设置GET列出预热语言GET列出预热行业POST开始预热POST停止预热POST批量预热操作POST批量更新预热设置GET预热活动历史

送达率

GET获取设置评分POST刷新设置评分GETDNS 健康检查POST获取送达率评分

报告

GET仪表板POST单账户报告POST批量报告POST导出报告

基础 URL#

https://app.inboxwarm.ai/api/v1

身份验证#

InboxWarm 根据 HTTP 方法采用混合身份验证方案：

GET

GET 和 DELETE 请求 — 将您的 API 密钥作为 api_key 查询参数发送。

POST

POST 和 PATCH 请求 — 将您的 API 密钥作为 JSON 正文中的 apiKey 字段发送。

在 InboxWarm 应用的 Developer kit > API Integration 中生成和管理密钥。每个密钥都授予对以下所有端点的完整账户访问权限。

示例 — GET 请求：

GET https://app.inboxwarm.ai/api/v1/email-accounts?api_key=YOUR_API_KEY

示例 — POST 请求正文：

{
  "apiKey": "YOUR_API_KEY",
  ...
}

速率限制#

默认限制为每个 API 密钥每分钟 20 个请求。您可随时通过 GET /rate-limit 查看当前使用情况 — 此调用不计入您的配额。

错误#

错误遵循一致的结构：

{
  "error_code": "validation_error",
  "message": "One or more fields are invalid.",
  "details": {}
}

常见的 error_code 值：validation_error（400）、not_found（404）、conflict（409）、unprocessable（422）。

端点索引#

系统

健康检查#

GEThttps://app.inboxwarm.ai/api/v1/health

API 的基本存活性检查。

身份验证:查询参数api_key

响应

{
  "status": "ok"
}

速率限制状态#

GEThttps://app.inboxwarm.ai/api/v1/rate-limit

在不消耗配额中请求次数的情况下查看当前的速率限制消耗情况。

身份验证:查询参数api_key

响应

{
  "limit": 20,
  "remaining": 18,
  "reset": 1752585600
}

电子邮件账户

列出电子邮件账户#

GEThttps://app.inboxwarm.ai/api/v1/email-accounts

列出已连接的电子邮件账户及其当前状态。支持搜索、分页和排序。如需重新解析某个地址，可使用搜索来查找其 emailAccountId。

身份验证:查询参数api_key

查询参数

search按电子邮件地址或名称搜索
statusactive | warming | paused | error | auth-expired
sort
sortBy

响应

{
  "items": [
    {
      "id": "12345",
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "status": "warming",
      "createdAt": "2026-06-01T10:00:00.000Z"
    },
    {
      "id": "12346",
      "fromEmail": "sales@yourcompany.com",
      "fromName": "Sales Team",
      "type": "microsoft",
      "status": "active",
      "createdAt": "2026-06-03T14:20:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

连接电子邮件账户#

POSThttps://app.inboxwarm.ai/api/v1/email-accounts

使用 SMTP/IMAP 凭据连接 Gmail、Microsoft 或 SMTP/IMAP 账户（Gmail 和 Microsoft 均可使用应用专用密码）。请保存返回的 emailAccountId — 其他所有端点都以它为键。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "fromEmail": "john@yourcompany.com",
  "fromName": "John Doe",
  "type": "gmail",
  "smtp": {
    "host": "smtp.example.com",
    "port": 587,
    "password": "your-password",
    "encryption": "TLS",
    "userName": "smtp-username"
  },
  "imap": {
    "host": "imap.example.com",
    "port": 993,
    "encryption": "SSL",
    "userName": "imap-username"
  }
}

响应

{
  "emailAccountId": "12345",
  "fromEmail": "john@yourcompany.com",
  "fromName": "John Doe",
  "type": "gmail",
  "status": "active"
}

批量连接电子邮件账户#

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-connect

在一次调用中最多可连接 20 个账户。每个条目都会被独立验证和连接 —— 一个账户的错误或重复不会影响其他账户 —— 响应将按照输入的相同顺序，报告每个账户的成功或失败结果。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccounts": [
    {
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "smtp": { "host": "smtp.example.com", "port": 587, "password": "your-password", "encryption": "TLS", "userName": "smtp-username" },
      "imap": { "host": "imap.example.com", "port": 993, "encryption": "SSL", "userName": "imap-username" }
    },
    {
      "fromEmail": "sales@yourcompany.com",
      "type": "microsoft",
      "smtp": { "password": "app-specific-password" }
    }
  ]
}

响应

{
  "results": [
    {
      "success": true,
      "emailAccountId": "12345",
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "status": "active"
    },
    {
      "success": false,
      "fromEmail": "sales@yourcompany.com",
      "error_code": "already_connected",
      "message": "This email address is already connected.",
      "details": {}
    }
  ]
}

断开电子邮件账户#

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}/disconnect

暂停账户而不删除它。配置和历史记录会被保留，以便日后重新连接。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}"
}

响应

{
  "emailAccountId": "12345",
  "status": "disconnected"
}

删除电子邮件账户#

DELETEhttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}

永久删除账户及所有相关的预热数据和历史记录。

身份验证:查询参数api_key

响应

无响应正文

批量删除电子邮件账户#

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-delete

在一次调用中永久删除最多 20 个账户。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ]
}

响应

{
  "results": [
    {
      "emailAccountId": "12345",
      "deleted": true
    },
    {
      "emailAccountId": "12346",
      "deleted": true
    }
  ]
}

获取电子邮件账户状态#

GEThttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}/status

单个账户的详细状态 — 连接健康状况、预热状态、身份验证状态、活动错误。

身份验证:查询参数api_key

响应

{
  "emailAccountId": "12345",
  "fromEmail": "john@yourcompany.com",
  "type": "gmail",
  "authStatus": "connected",
  "warmupStatus": "active",
  "healthScore": 92,
  "connectionError": null,
  "lastConnectedAt": "2026-07-15T08:00:00.000Z"
}

批量电子邮件账户状态#

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-status

在一次调用中获取最多 50 个账户的状态，按输入 ID 的相同顺序返回。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ]
}

响应

{
  "results": [
    {
      "emailAccountId": "12345",
      "fromEmail": "john@yourcompany.com",
      "type": "gmail",
      "authStatus": "connected",
      "warmupStatus": "active",
      "healthScore": 92,
      "connectionError": null,
      "lastConnectedAt": "2026-07-15T08:00:00.000Z"
    },
    {
      "emailAccountId": "12346",
      "fromEmail": "sales@yourcompany.com",
      "type": "microsoft",
      "authStatus": "connected",
      "warmupStatus": "paused",
      "healthScore": 81,
      "connectionError": null,
      "lastConnectedAt": "2026-07-14T22:10:00.000Z"
    }
  ]
}

预热

获取预热设置#

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}

获取某个账户的当前预热配置。

身份验证:查询参数api_key

响应

{
  "emailAccountId": "12345",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

更新预热设置#

PATCHhttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}

更新某个账户的一项或多项预热设置 —— 发件人姓名、时区、发送时间表、语言、行业或主题。仅会更改您发送的字段。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

响应

{
  "emailAccountId": "12345",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

列出预热语言#

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/languages

列出可生成预热内容的所有语言，以便了解 warmupLanguage 接受哪些值。

身份验证:查询参数api_key

响应

{
  "languages": [
    { "code": "en", "name": "English", "nativeName": "English", "script": "Latin" },
    { "code": "es", "name": "Spanish", "nativeName": "Español", "script": "Latin" },
    { "code": "ja", "name": "Japanese", "nativeName": "日本語", "script": "Japanese" }
  ]
}

列出预热行业#

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/industries

列出所有目标行业及其推荐主题，以便了解 targetIndustry 和 warmupTopics 接受哪些值。

身份验证:查询参数api_key

响应

{
  "industries": [
    {
      "key": "e_commerce",
      "name": "E-Commerce",
      "topics": [
        "Abandoned cart follow-up",
        "New product launch",
        "Seasonal sale announcement",
        "Order and shipping update",
        "Customer review request"
      ]
    },
    {
      "key": "saas_software",
      "name": "SaaS / Software",
      "topics": ["Feature announcement", "Onboarding tip", "Case study"]
    }
  ]
}

开始预热#

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}/start

为某个账户开始预热。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}"
}

响应

{
  "emailAccountId": "12345",
  "warmupStatus": "active"
}

停止预热#

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}/stop

为某个账户停止预热。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}"
}

响应

{
  "emailAccountId": "12345",
  "warmupStatus": "paused"
}

批量预热操作#

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/bulk-action

在一次调用中为最多 50 个账户开始或停止预热。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "action": "start"
}

响应

{
  "results": [
    {
      "emailAccountId": "12345",
      "status": "ok"
    },
    {
      "emailAccountId": "12346",
      "status": "ok"
    }
  ]
}

批量更新预热设置#

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/bulk-update

在一次调用中为最多 50 个账户应用时间表和/或内容设置。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "apply": ["language", "window"],
  "warmupLanguage": "es",
  "sendingWindowStartTime": "06:00",
  "sendingWindowEndTime": "10:00"
}

响应

{
  "updatedCount": 2
}

预热活动历史#

GEThttps://app.inboxwarm.ai/api/v1/warmup-status/{emailAccountId}

某个账户当天的预热活动：已发送、已接收、已回复、垃圾邮件、退回。

身份验证:查询参数api_key

响应

{
  "emailAccountId": "12345",
  "date": "2026-07-15",
  "current": "active",
  "dailySendingLimit": 10,
  "sent": 12,
  "received": 10,
  "replied": 7,
  "spam": 1,
  "bounced": 0
}

送达率

获取设置评分#

GEThttps://app.inboxwarm.ai/api/v1/setup-score/{emailAccountId}

某个账户的缓存设置健康评分（DMARC、SPF、DKIM、MX、黑名单检查）。

身份验证:查询参数api_key

响应

{
  "emailAccountId": "12345",
  "emailAccountScore": 86,
  "dmarcScore": 15,
  "spfScore": 29,
  "dkimScore": 18,
  "mxRecordScore": 9,
  "ipBlacklistScore": 5,
  "domainBlacklistScore": 10,
  "updatedAt": "2026-07-14T10:30:00.000Z",
  "manualLastRefreshedAt": "2026-07-14T10:30:00.000Z"
}

刷新设置评分#

POSThttps://app.inboxwarm.ai/api/v1/setup-score/{emailAccountId}/refresh

同步重新计算某个账户的设置评分。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}"
}

响应

{
  "emailAccountId": "12345",
  "emailAccountScore": 88,
  "dmarcScore": 15,
  "spfScore": 29,
  "dkimScore": 18,
  "mxRecordScore": 9,
  "ipBlacklistScore": 7,
  "domainBlacklistScore": 10,
  "updatedAt": "2026-07-15T09:00:00.000Z",
  "manualLastRefreshedAt": "2026-07-15T09:00:00.000Z"
}

DNS 健康检查#

GEThttps://app.inboxwarm.ai/api/v1/dns-health/{emailAccountId}

对账户发送域进行实时 DNS 查询 — SPF、DKIM、DMARC、MX 的通过/失败结果。

身份验证:查询参数api_key

响应

{
  "emailAccountId": "12345",
  "spf": "pass",
  "dkim": "pass",
  "dmarc": "pass",
  "mx": "pass",
  "cachedAt": "2026-07-15T09:00:00.000Z"
}

获取送达率评分#

POSThttps://app.inboxwarm.ai/api/v1/deliverability-score/{emailAccountId}

某个日期范围内的整体及各 ESP 的收件箱与垃圾邮件送达率。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "startDate": "2026-06-01",
  "endDate": "2026-06-30",
  "esps": [
    "gmail",
    "outlook",
    "other"
  ]
}

响应

{
  "emailAccountId": "12345",
  "totalDeliverabilityRate": 88,
  "totalSentCount": 1500,
  "totalInboxCount": 1320,
  "totalSpamInboxCount": 180,
  "gmail": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  },
  "outlook": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  },
  "other": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  }
}

报告

仪表板#

GEThttps://app.inboxwarm.ai/api/v1/dashboard

所有已连接收件箱的账户级预热摘要。

身份验证:查询参数api_key

响应

{
  "totalAccounts": 42,
  "activeWarmups": 30,
  "pausedWarmups": 8,
  "accountsWithErrors": 2,
  "avgSetupScore": 78.5
}

单账户报告#

POSThttps://app.inboxwarm.ai/api/v1/reports

某个账户在某个日期范围内的每日预热报告。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountId": "12345",
  "from": "2026-06-01",
  "to": "2026-06-30"
}

响应

{
  "emailAccountId": "12345",
  "from": "2026-06-01",
  "to": "2026-06-30",
  "days": [
    {
      "date": "2026-06-15",
      "sent": 25,
      "inbox": 20,
      "received": 22,
      "spam": 3,
      "bounced": 1,
      "undelivered": 0,
      "replied": 5,
      "deliverabilityRate": 92.5
    }
  ]
}

批量报告#

POSThttps://app.inboxwarm.ai/api/v1/reports/bulk

最多 50 个账户在某个日期范围内的每日预热报告。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "from": "2026-06-01",
  "to": "2026-06-30"
}

响应

{
  "reports": [
    {
      "emailAccountId": "12345",
      "from": "2026-06-01",
      "to": "2026-06-30",
      "days": [
        {
          "date": "2026-06-15",
          "sent": 25,
          "inbox": 20,
          "received": 22,
          "spam": 3,
          "bounced": 1,
          "undelivered": 0,
          "replied": 5,
          "deliverabilityRate": 92.5
        }
      ]
    }
  ]
}

导出报告#

POSThttps://app.inboxwarm.ai/api/v1/reports/export

启动预热报告的异步 CSV 导出，准备就绪后通过电子邮件发送。

身份验证:正文字段apiKey

请求正文

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "from": "2026-06-01",
  "to": "2026-06-30"
}

响应

{
  "jobId": "a1b2c3d4",
  "status": "queued"
}