Bird 产品

十一个界面。 一个平台。 统一架构。

Email、Mailbox、SMS、Voice、WhatsApp、Verify、Lookup、RCS、Push、Realtime 和 eSIM — 每一款都是一流的 API。相同的认证、相同的幂等性、相同的 Webhooks、相同的错误封装。学会一个,即通晓全部。

设置方式:
Cursor

全部产品。 十一个界面,一套 SDK。

01POST /v1/emails

Email. 为同时处理多种消息的开发者打造的邮件 API。

welcome.tsx
await bird.email.send({
  from: "hello@yourdomain.com",
  to: ["alex@example.com"],
  subject: "Welcome to Bird",
  html: "<p>You're in. Let's ship.</p>",
});
02POST /v1/email/mailboxes

Mailbox. Mailbox API,为能自主回复邮件的智能代理而生。

claim-mailbox.sh
curl -X POST https://us1.platform.bird.com/v1/email/mailboxes \
  -H "Authorization: Bearer $BIRD_API_KEY" \
  -d '{"domain": "inbox.ai", "receive_policy": "open"}'

{
  "id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "k7mq3vx2npr5wcj4tzh6@inbox.ai",
  "state": "active"
}
03POST /v1/sms/messages

SMS. 为真正需要快速交付的开发者打造的 SMS API。

notify.ts
await bird.sms.send({
  to: "+15005550006",
  text: "Your code is 847291. Expires in 10 min.",
  category: "authentication",
});
04POST /v1/voice/calls

Voice. 用 JSON 实现可编程语音。通话、IVR、录音、TTS。

dial.ts
await bird.voice.calls.create({
  to: "+15005550010",
  from: "+14155550199",
  flow: [
    { say: "Your order is confirmed." },
  ],
});
Voice 正在升级中
05POST /v1/whatsapp/messages

WhatsApp. 通过 WhatsApp API 与全球客户互动。

message.ts
await bird.whatsapp.send({
  from: "+15557654321",
  to:   "+15005550006",
  text: { body: "Order confirmed! 🎉" },
});
06POST /v1/verify/verifications

Verify. 为需要验证码必达的开发者打造的 OTP API。

verify.ts
await bird.verify.verifications.create({
  to: { phone_number: "+15005550006" },
});
// check by target — no id to store
await bird.verify.verifications.check({
  to: { phone_number: "+15005550006" }, code: userCode,
});
07POST /v1/lookup/phone-number

Lookup. 在发送之前验证手机号码或电子邮件地址。

lookup.ts
await bird.lookup.phoneNumber({
  phone_number: "+31612345678",
});
08POST /v1/rcs

RCS. RCS for Business API,SMS 更出色的升级版。

rich.ts
await bird.rcs.send({
  to: "+15005550006",
  text: "Your order shipped! 📦",
  suggestions: [
    { type: "openUrl", text: "Track it", url },
  ],
});
RCS 正在升级中
09POST /v1/push

Push. 适用于 iOS、Android 和 Web 的推送通知。

push.ts
await bird.push.send({
  to: { deviceToken },
  notification: {
    title: "Order shipped!",
    body: "Your package is on its way.",
  },
});
Push 正在升级中
10POST /v1/realtime/publish

Realtime. 基于 WebSocket 的托管发布/订阅服务。订阅、发布、弹性扩展。

realtime.ts
await bird.realtime.publish("rap_01krdgeqcxet5s7t44vh8rt9mg", {
  channels: ["orders"],
  event: "order.shipped",
  data: { orderId, status: "shipped" },
});
11POST /v1/esims

eSIM. 企业 eSIM、员工手机套餐,为您的产品提供连接能力。

esim.ts
await bird.esim.issue({
  recipient: { externalId: employeeId },
  plan: { region: "eu", dataMb: 5_000 },
  policy: { blockStreaming: true },
});
eSIM API 即将登陆 Bird

以上每个产品共享同一套认证模型、同一套幂等性契约、同一套错误封装、同一套 Webhook 契约、同一套游标分页方案。学会一个,就等于学会了全部。

/ Auth

/ Idempotency

/ Errors

/ Webhooks

/ Pagination

/ Typed IDs

查看 API 端点

Put it into practice.

Continue with the documentation, guides and examples for this topic. Resources are in English.

从一个渠道开始。
准备好后,再添加其他渠道。

测试 API 密钥即刻可用。添加支付方式并验证发送者身份后,即可解锁生产环境。

正在使用 Claude Code、Cursor 或 Codex?复制一条设置提示,您的智能代理即可自动安装 Bird CLI 和相关技能。选择您的工具:

Cursor