Sign inGet Started

cURL

仅用 curl 发送第一封邮件:导出 API 密钥,POST 一条消息,然后 GET 它以观察投递过程。这是原始的 HTTP 流程;SDK 所做的一切都从这里开始。

1. 导出你的 API 密钥

在控制台的 Developers > API keys 下创建密钥(发送第一封邮件中有详细步骤),然后导出它:
代码示例
export BIRD_API_KEY="bk_us1_..."
区域前缀决定你的 API 主机:bk_us1_ 密钥调用 https://us1.platform.bird.com,bk_eu1_ 密钥调用 https://eu1.platform.bird.com。发送示例使用 us1;如果你的密钥属于其他区域,请更改主机。

2. 发送一封邮件

向 /v1/email/messages 发送 POST 请求,使用我们共享的入门域名发送到 delivered@messagebird.dev 沙箱地址。你不需要域名验证或真实邮箱。在本快速入门中选择 cURL 标签页。
const msg = await bird.email.send({
  from: { email: "onboarding@messagebird.dev", name: "Bird" },
  to: ["delivered@messagebird.dev"],
  subject: "Hello from Bird",
  html: "<p>My first Bird email.</p>",
});
console.log(msg.id, msg.status); // "em_…", "accepted"
API 返回 202:Bird 已接受邮件并异步投递。*_count 字段跟踪收件人的投递状态。在初始响应中,一个收件人已被接受,尚无投递完成:
代码示例
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}
原始 HTTP 没有 SDK 为您生成幂等键。为了实现重试保护,请在首次尝试时提供一个键,并在重试时复用该键。参阅幂等性了解示例和重放限制。

3. 观察投递过程

通过 em_ ID 对消息发送 GET 请求,观察状态从 accepted 经过 processed 变为 delivered。再次选择 cURL 标签页:
const msg = await bird.email.get("em_abc123");
msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
msg.delivered_count;
msg.bounced_count;
由于收件人是 delivered@messagebird.dev 沙箱地址,投递是有保证的:消息会经过 Bird 的真实管道,但不会到达真实邮箱。

后续步骤