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.

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);from bird import APIError, Bird
with Bird() as client:
try:
message = client.email.send(
from_={"email": "onboarding@messagebird.dev", "name": "Bird"},
to=["delivered@messagebird.dev"],
subject="Hello from Bird",
html="<p>My first Bird email.</p>",
)
print(message.id, message.status)
except APIError as err:
print("send failed:", err)package main
import (
"encoding/json"
"errors"
"log"
"net/http"
"os"
bird "github.com/messagebird/bird-sdk-go"
"github.com/messagebird/bird-sdk-go/option"
)
func main() {
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
http.HandleFunc("POST /send", func(w http.ResponseWriter, r *http.Request) {
msg, err := client.Email.Send(r.Context(), bird.EmailSendParams{
From: "onboarding@messagebird.dev",
To: []string{"delivered@messagebird.dev"},
Subject: "Hello from Bird",
HTML: "<p>My first Bird email.</p>",
})
if err != nil {
var apiErr *bird.APIError
if errors.As(err, &apiErr) {
http.Error(w, apiErr.Error(), apiErr.StatusCode)
return
}
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusAccepted)
_ = json.NewEncoder(w).Encode(msg)
})
log.Fatal(http.ListenAndServe(":3000", nil))
}<?php
// Send your first email. Set BIRD_API_KEY in your environment, then run:
// php examples/quickstart-email.php
declare(strict_types=1);
require __DIR__ . '/../vendor/autoload.php';
use MessageBird\Bird;
$bird = new Bird(getenv('BIRD_API_KEY') ?: '');
$message = $bird->email->send(
from: 'Bird <onboarding@messagebird.dev>',
to: ['delivered@messagebird.dev'],
subject: 'Hello from Bird',
html: '<p>My first Bird email.</p>',
);
echo $message->getId(), ' ', $message->getStatus(), "\n";bird email send \
--from 'Bird <onboarding@messagebird.dev>' \
--html '<p>My first Bird email.</p>' \
--subject 'Hello from Bird' \
--to delivered@messagebird.devcurl -X POST "https://us1.platform.bird.com/v1/email/messages" \
-H "Authorization: Bearer $BIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"from": { "email": "onboarding@messagebird.dev", "name": "Bird" },
"to": ["delivered@messagebird.dev"],
"subject": "Hello from Bird",
"html": "<p>My first Bird email.</p>"
}'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;message = client.email.get("em_abc123")
print(message.id, message.status, message.delivered_count)package main
import (
"context"
"fmt"
"log"
"os"
bird "github.com/messagebird/bird-sdk-go"
"github.com/messagebird/bird-sdk-go/option"
)
func main() {
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
msg, err := client.Email.Get(context.Background(), "em_abc123")
if err != nil {
log.Fatal(err)
}
fmt.Println(*msg.Status, *msg.DeliveredCount)
}$message = $bird->email->get('em_01krdgeqcxet5s7t44vh8rt9mg');
echo $message->getStatus();bird email get <message-id>curl -X GET "https://{region}.platform.bird.com/v1/email/messages/{message_id}" \
-H "Authorization: Bearer $TOKEN"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
- Quickstarty dla poszczególnych SDK: ten sam przepływ w Twoim języku i frameworku.
- Domeny nadawcze: zweryfikuj własną domenę do wysyłki produkcyjnej.
- Sandbox testowy: wszystkie adresy sandbox i zdarzenia, które wyzwalają.
- Dokumentacja API e-mail: pełny schemat żądania i odpowiedzi.
- Pierwsze kroki z e-mailem: wideo z onboardingu w panelu, które wykracza poza ten przewodnik i obejmuje dodanie domeny nadawczej z rekordami DNS
Powiązane zasoby
Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.
Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Poznaj możliwościEmailPodążaj ścieżką naukiBuild your first integration
Wypróbuj ćwiczenie i uzyskaj brief wdrożeniowy