Sign inGet Started

TypeScript / Node.js

Senden Sie eine E-Mail aus einem einfachen Node.js-Skript mit @messagebird/sdk. Sie benötigen einen Bird API-Schlüssel: Erstellen Sie einen unter Platform tools > API keys (Erste E-Mail senden führt Sie durch die Schritte) und exportieren Sie ihn als BIRD_API_KEY.

1. Installieren

Codebeispiel
npm init -y
npm install @messagebird/sdk tsx

Das SDK erfordert Node.js 20.3+ und ist ausschließlich ESM.

2. Senden

Erstellen Sie send.ts:

Codebeispiel
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);

onboarding@messagebird.dev ist der gemeinsame Onboarding-Absender von Bird, und delivered@messagebird.dev ist ein Sandbox-Empfänger, an den immer zugestellt wird: Sie müssen keine Domain verifizieren. Das SDK leitet die Region aus dem bk_us1_-/bk_eu1_-Präfix Ihres Schlüssels ab (Sie müssen keine Base-URL konfigurieren) und erzeugt pro Aufruf automatisch einen Idempotency-Key, sodass Sie das Senden gefahrlos erneut versuchen können.

3. Ausführen

Codebeispiel
npx tsx send.ts

Das Skript gibt die Nachrichten-ID und den Status aus:

Codebeispiel
em_01ky7ma8y2es1s2akzk53tmjn0 accepted

accepted ist der 202 des API: Bird hat die Nachricht und stellt sie asynchron zu. Rufen Sie sie über ihre em_-ID mit bird.email.get(msg.id) ab und beobachten Sie, wie der Status zu delivered wechselt.

Nächste Schritte

  • TypeScript-SDK: die vollständige E-Mail-Oberfläche (send, get, list) und das Fehlermodell.
  • Erste E-Mail senden: einen API-Schlüssel erstellen und die vollständige Liste der Sandbox-Adressen.
  • Sende-Domains: Ihre eigene Domain für den Produktionsversand verifizieren.
  • E-Mail-API-Referenz: das vollständige Request- und Response-Schema.