Bird Products

Onze superfícies. Uma plataforma. Mesmo formato.

Email, Mailbox, SMS, Voice, WhatsApp, Verify, Lookup, RCS, Push, Realtime e eSIM — cada um uma API de primeira classe. Mesma autenticação, mesma idempotência, mesmos webhooks, mesmo envelope de erro. Aprenda um, e já aprendeu todos.

Configure em:
Cursor

Todos os produtos. Onze superfícies, um SDK.

01POST /v1/emails

Email. A API de email para desenvolvedores que também enviam o resto da mensagem.

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. A API Mailbox para agentes que respondem aos seus próprios e-mails.

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. A API de SMS para desenvolvedores que precisam mesmo de entregar.

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

Voice. Voz programável em JSON. Chamadas, IVR, gravação, TTS.

dial.ts
await bird.voice.calls.create({
  to: "+15005550010",
  from: "+14155550199",
  flow: [
    { say: "Your order is confirmed." },
  ],
});
Voice está a ser atualizado
05POST /v1/whatsapp/messages

WhatsApp. Interaja com clientes em todo o mundo com a WhatsApp API.

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

Verify. A API de OTP para desenvolvedores que precisam que os códigos cheguem.

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. Verifique um número de telefone ou endereço de e-mail antes de enviar.

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

RCS. A API do RCS for Business, o irmão mais bonito do SMS.

rich.ts
await bird.rcs.send({
  to: "+15005550006",
  text: "Your order shipped! 📦",
  suggestions: [
    { type: "openUrl", text: "Track it", url },
  ],
});
RCS está a ser atualizado
09POST /v1/push

Push. Notificações push para iOS, Android e web.

push.ts
await bird.push.send({
  to: { deviceToken },
  notification: {
    title: "Order shipped!",
    body: "Your package is on its way.",
  },
});
Push está a ser atualizado
10POST /v1/realtime/publish

Realtime. Pub/sub hospedado via WebSocket. Subscreva, publique, escale.

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

eSIM. eSIMs corporativos, planos telefónicos para colaboradores, conectividade no seu produto.

esim.ts
await bird.esim.issue({
  recipient: { externalId: employeeId },
  plan: { region: "eu", dataMb: 5_000 },
  policy: { blockStreaming: true },
});
A API de eSIM está a chegar à Bird

Todos os produtos acima partilham um modelo de autenticação, um contrato de idempotência, um envelope de erros, um contrato de webhooks e um esquema de paginação por cursor. Aprenda um, aprendeu todos.

/ Auth

/ Idempotency

/ Errors

/ Webhooks

/ Pagination

/ Typed IDs

Veja os endpoints da API

Put it into practice.

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

Comece com um canal.
Adicione os outros quando estiver pronto.

Uma chave API de teste é sua imediatamente. A produção é desbloqueada quando você adiciona um método de pagamento e verifica um remetente.

Usa Claude Code, Cursor ou Codex? Copie um prompt de configuração e o seu agente instala o Bird CLI e as skills por si. Escolha o seu:

Cursor