smartlead-api

Smartlead API 参考

身份验证

所有请求均使用查询参数进行身份验证：?api_key={SMARTLEAD_API_KEY}

环境变量：$SMARTLEAD_API_KEY

基础 URL：https://server.smartlead.ai/api/v1

速率限制

• 标准套餐： 2,000 次请求/分钟（33 次请求/秒）
• 更高套餐： 3,000 次请求/分钟（50 次请求/秒）
• 收到 429 和 5xx 响应时，采用指数退避策略重试
• 对于批量操作，使用 p-limit 或 PQueue，并发数设为 8-15

CLI 快速参考

smartlead CLI（@smartlead/cli）封装了所有 API 端点。可用它快速查询：

# Campaigns
smartlead campaigns list
smartlead campaigns get <id>
smartlead campaigns create --name "Campaign Name"

# Leads
smartlead leads list --campaign-id <id>
smartlead leads add --campaign-id <id> --file leads.csv

# Email accounts
smartlead email-accounts list
smartlead email-accounts get <id>

# Analytics
smartlead analytics campaign <id>
smartlead analytics overall

# Master inbox
smartlead inbox replies

API 端点

Campaigns

GET  /campaigns/{id}                    — Fetch campaign by ID
POST /campaigns/create                  — Create new campaign
POST /campaigns/{id}/status             — Update status (START, PAUSED, STOP)
     Body: { "status": "START" }

Campaign Email Accounts

GET    /campaigns/{id}/email-accounts   — List accounts assigned to campaign
POST   /campaigns/{id}/email-accounts   — Add accounts to campaign
       Body: { "email_account_ids": [1, 2, 3] }
DELETE /campaigns/{id}/email-accounts   — Remove accounts from campaign

Campaign Sequences

GET  /campaigns/{id}/sequences          — Fetch sequences
POST /campaigns/{id}/sequences          — Save/update sequences
     Body: { "sequences": [{ "seq_number": 1, "seq_delay_details": { "delay_in_days": 0 }, "subject": "...", "email_body": "..." }] }

A/B/C 变体 — 在每个序列中使用 seq_variants 数组：

{
  "sequences": [{
    "seq_number": 1,
    "seq_delay_details": { "delay_in_days": 0 },
    "seq_variants": [
      { "variant_label": "A", "subject": "Subject A", "email_body": "<div>Body A</div>" },
      { "variant_label": "B", "subject": "Subject B", "email_body": "<div>Body B</div>" },
      { "variant_label": "C", "subject": "Subject C", "email_body": "<div>Body C</div>" }
    ]
  }]
}

注意：请勿包含 distribution 字段 — SmartLead 会自动均匀分配。

邮件正文顺序： 正文内容 → PS 退订行 → %signature%（签名始终放在最后）

Campaign Settings & Schedule

POST /campaigns/{id}/settings           — Update settings
     Body: { "track_settings": [...], "stop_lead_settings": "..." }

POST /campaigns/{id}/schedule           — Update schedule
     Body: { "timezone": "US/Eastern", "days_of_the_week": [1,2,3,4,5], "start_hour": "08:00", "end_hour": "17:00", "min_time_btw_emails": 8, "max_new_leads_per_day": 30 }

Leads

GET  /leads/?api_key={key}&email={email}
     — Lookup lead by email address

POST /campaigns/{id}/leads
     — Add leads to campaign (batch up to 100)
     Body: { "lead_list": [{ "email": "...", "first_name": "...", "last_name": "...", "company_name": "...", "custom_fields": { "field1": "value1" } }] }

Analytics

GET /analytics/day-wise-overall-stats
    ?api_key={key}&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD
    — Day-by-day metrics (sent, opened, clicked, replied, bounced)

GET /analytics/day-wise-positive-reply-stats
    ?api_key={key}&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD
    — Day-by-day positive reply counts

GET /analytics/overall-stats-v2
    ?api_key={key}&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD
    — Overall campaign metrics for date range

GET /analytics/campaign/list
    ?api_key={key}
    — List all campaigns with summary stats

GET /campaigns/{id}/analytics
    ?api_key={key}
    — Analytics for specific campaign

GET /campaigns/{id}/analytics-by-date
    ?api_key={key}&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD
    — Campaign analytics for specific date range (sent_count, reply_count)

Email Accounts（全局）

GET  /email-accounts
     ?api_key={key}&offset=0&limit=100
     — List all email accounts (paginated)

GET  /email-accounts/{id}
     ?api_key={key}
     — Get specific email account

POST /email-accounts/save
     — Create/update email account (SMTP details, warmup, etc.)

Master Inbox

POST /master-inbox/inbox-replies
     Body: { "api_key": "...", "offset": 0, "limit": 50, "message_type": "RECEIVED" }
     — Fetch inbox replies with filtering and pagination

子客户端 / 自定义 API 密钥模式

• 普通子客户端： 在所有请求中传递 ?api_key={MAIN_KEY}&client_id={CLIENT_ID}
• 自定义 API 密钥客户端： 直接使用客户端自己的 API 密钥，无需 client_id 参数

TypeScript 模式

const SMARTLEAD_API = "https://server.smartlead.ai/api/v1";
const API_KEY = process.env.SMARTLEAD_API_KEY;

// GET example
const res = await fetch(`${SMARTLEAD_API}/campaigns/${campaignId}?api_key=${API_KEY}`);
const campaign = await res.json();

// POST example (add leads)
const res = await fetch(`${SMARTLEAD_API}/campaigns/${campaignId}/leads?api_key=${API_KEY}`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ lead_list: leads.slice(0, 100) }),
});

性能提示：缓存 email-accounts 列表

如果脚本中多次请求 /email-accounts，请在开始时分页获取一次，并将结果保存在内存中。Smartlead 的分页每页返回 100 条记录 — 对于拥有数千个收件箱的账户，完整遍历需要 30 秒以上。

如需在多个脚本间持久缓存，可将列表写入本地 JSON 文件，并定时刷新（例如每小时一次）。/smartlead-inbox-manager 技能中的脚本实现了这种模式。

---

下一步

这是一个参考技能 — 没有直接的下一步。所有与 Smartlead 交互的技能都会使用它（/smartlead-inbox-manager、/smartlead-campaign-upload-public、/email-deliverability-audit、/positive-reply-scoring、/deliverability-incident-response 等）。

返回到将你带到这里的技能。

相关技能

• 所有涉及 Smartlead 的技能都会使用此参考。