Sign inGet Started

Wyślij swój pierwszy e-mail

Utwórz klucz API, wyślij przez współdzieloną domenę onboardingową Bird i sprawdź wynik. W tym przewodniku nie musisz weryfikować domeny nadawczej ani publikować rekordów DNS. Zweryfikuj własną domenę przed wysyłką do klientów.

1. Utwórz klucz API

W panelu przejdź do Developers > Klucze API i utwórz klucz. Klucze są przypisane do regionu i wyglądają jak bk_us1_... lub bk_eu1_...; region w prefiksie wskazuje, którego hosta API wywołać: https://us1.platform.bird.com lub https://eu1.platform.bird.com.
Strona kluczy API w panelu Bird z listą kluczy, zamaskowanym prefiksem, zakresami uprawnień i czasem ostatniego użycia
Pełny klucz jest wyświetlany tylko raz, w momencie utworzenia. Skopiuj go w bezpieczne miejsce, a następnie wyeksportuj, aby fragmenty kodu z kroku 2 mogły go odczytać:
Przykład kodu
export BIRD_API_KEY="bk_us1_..."

2. Wyślij e-mail

Wyślij z onboarding@messagebird.dev, współdzielonej domeny onboardingowej Bird, dostępnej w Twoim obszarze roboczym bez dodatkowej konfiguracji. Zaadresuj wiadomość do delivered@messagebird.dev, odbiorcy sandbox, który zawsze potwierdza dostarczenie, więc wynik jest deterministyczny bez prawdziwej skrzynki pocztowej.
Wywołanie cURL wskazuje hosta w USA. Jeśli Twój klucz zaczyna się od bk_eu1_, wywołaj zamiast tego https://eu1.platform.bird.com. SDK odczytuje region z klucza i wybiera odpowiedniego hosta. Karta TypeScript wymaga npm install @messagebird/sdk.
import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

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);
Pełne instrukcje instalacji i uruchomienia w poszczególnych językach i frameworkach znajdziesz w quickstartach SDK.

3. Sprawdź wynik

API odpowiada 202: Bird przyjął wysyłkę do przetwarzania asynchronicznego. Status dostarczenia sprawdź osobno. Pola *_count śledzą odbiorców przez kolejne stany dostarczenia. W początkowej odpowiedzi jeden odbiorca jest zaakceptowany, a żaden nie jest dostarczony.
Przykład kodu
{
  "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"
}
Pobierz wiadomość po jej em_ ID, aby sprawdzić bieżący stan. Wiadomość przechodzi od accepted przez processed do delivered. Odpytuj, aż wiadomość sandbox osiągnie delivered:
const msg = await bird.email.get("em_abc123");
msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
msg.delivered_count;
msg.bounced_count;
W karcie cURL zamień {region} i {message_id} oraz użyj $BIRD_API_KEY zamiast $TOKEN.
Odczyt pokazuje teraz status: "delivered", delivered_count: 1 oraz znacznik czasu delivered_at. W przewodniku po zdarzeniach sprawdzisz, co delivered ustala dla prawdziwego odbiorcy.
Ponieważ wysłałeś do delivered@messagebird.dev, wynik jest gwarantowany: wiadomość przechodzi przez prawdziwy potok dostarczania Bird, łącznie z produkcyjnymi zdarzeniami i strukturami webhooków, ale nigdy nie trafia do prawdziwej skrzynki pocztowej. Aby przetestować odrzucenie, wyślij do bounce@messagebird.dev. Przewodnik po sandboxie testowym zawiera listę wszystkich adresów sandbox i ich symulowanych wyników.

Domena onboardingowa

Współdzielony nadawca onboarding@messagebird.dev jest dostępny na potrzeby onboardingu i ma następujące ograniczenia:
  • Poza adresami sandbox @messagebird.dev dostarczanie odbywa się wyłącznie do zweryfikowanych członków Twojego obszaru roboczego; każdy inny odbiorca jest odrzucany z 422.
  • Wysyłki są ograniczone do 50 odbiorców na organizację na dobę UTC, licząc każdy adres to, cc i bcc, w tym odbiorców sandbox. Po przekroczeniu limitu API zwraca 429.
Gdy będziesz gotowy wysyłać e-maile do prawdziwych klientów, zweryfikuj własną domenę nadawczą i wstaw swój adres w from; cała reszta żądania pozostaje taka sama.

Następne kroki

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Wypróbuj ćwiczenie i uzyskaj brief wdrożeniowy