Sign inGet Started
Começar
Guias
Referência de API
SDKs
CLI
Base de conhecimento
Changelog

CLI

Envie seu primeiro e-mail de um terminal macOS ou Linux: instale o bird CLI, faça login uma vez e envie. Você não precisa copiar uma chave API.

1. Instalar

Exemplo de código
curl -fsSL https://cli.bird.com/install.sh | sh
Execute bird version para confirmar que a instalação foi bem-sucedida. Para Windows e outras opções de instalação, consulte Instalar o CLI.

2. Fazer login

Exemplo de código
bird auth login --scope emails:write
Isso abre uma página de consentimento no navegador onde você escolhe um espaço de trabalho e aprova a concessão. O escopo emails:write permite que o passo 3 envie. Sem ele, bird auth login solicita acesso somente leitura e o envio é recusado. O CLI armazena um token OAuth vinculado ao espaço de trabalho em ~/.config/bird/credentials.json, renova-o quando necessário e registra a região do espaço de trabalho.

3. Enviar um e-mail

Envie a partir do domínio compartilhado de onboarding do Bird para o endereço sandbox delivered@messagebird.dev: sem verificação de domínio, sem necessidade de caixa de e-mail real.
Exemplo de código
bird email send \
  --from onboarding@messagebird.dev \
  --to delivered@messagebird.dev \
  --subject "Hello from Bird" \
  --html "<p>My first Bird email.</p>"
O CLI imprime a mensagem aceita como JSON. Os campos *_count rastreiam os destinatários pelos estados de entrega. Na resposta inicial, um destinatário é aceito e nenhum foi entregue:
Exemplo de código
{
  "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"
}
--to é repetível para vários destinatários, --text envia um corpo em texto simples e --dry-run imprime a solicitação resolvida sem enviá-la.

4. Verificar o resultado

accepted significa que Bird aceitou a mensagem e a entrega de forma assíncrona. Leia-a de volta pelo ID em_ e acompanhe o status até alcançar delivered:
Exemplo de código
bird email get em_01ky7ma8y2es1s2akzk53tmjn0
Adicione --format text para um cartão legível em vez de JSON.
Todo comando escreve JSON na saída padrão por padrão. Erros usam uma resposta de erro JSON na saída de erro padrão, e os códigos de saída identificam categorias de falha. Consulte o CLI para agentes para o contrato completo.

Próximos passos

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico. Os recursos estão em inglês.

Assista ao guiaTesting email without spamming anyoneExplore a funcionalidadeTest email deliverySiga o percurso de aprendizagemOperate messaging reliably
Experimente na prática e obtenha um resumo de implementação