Sign inGet started

WhatsApp-Übersicht

Bird WhatsApp nutzt dieselbe Plattform und dieselben API-Schlüssel wie Bird Email und Bird SMS. Rufen Sie den regionalen Host für den API-Schlüssel auf (https://us1.platform.bird.com oder https://eu1.platform.bird.com). WhatsApp-Endpunkte befinden sich unter /v1/whatsapp/….
Vom Unternehmen initiierte Nachrichten verwenden ein vorab genehmigtes Nachrichtentemplate. Senden Sie eines aus dem verwalteten Katalog von Bird, der keine eigene Nummer erfordert und über einen Bird-verwalteten Absender versendet, oder verbinden Sie eine eigene Nummer und senden Sie Ihre eigenen Templates darüber. Kontakte können an eine Ihrer eigenen Nummern schreiben, und Bird zeichnet diese eingehenden Nachrichten zusammen mit den ausgehenden auf.

So funktioniert der Versand

Senden Sie eine WhatsApp-Nachricht mit POST /v1/whatsapp/messages: ein Empfänger, ein Template sowie optionale Tags und Metadaten. Wir validieren die Anfrage und geben 202 Accepted mit einer Nachrichten-ID zurück. Abrechnung und Zustellung erfolgen asynchron. Die API hat keinen Batch-Endpunkt, senden Sie also eine Anfrage pro Nachricht.
Drei Konzepte bestimmen die gesamte API:
  • Versand und Zustellung sind getrennte Phasen. Ein 202 bedeutet, dass Bird die Nachricht angenommen hat. Das Gerät des Empfängers erhält sie erst, nachdem die Nachricht über WhatsApp ein endgültiges Zustellergebnis erreicht hat. Eine Lesebestätigung erscheint als read_at-Zeitstempel und whatsapp.read-Event; sie ändert den Nachrichtenstatus nicht.
  • Jeder vom Unternehmen initiierte Versand verwendet ein Template. Geben Sie den Template-slug, eine optionale language und Werte für die Variablen an. Eine Servicenachricht, also Freitext oder Medien, erreicht einen Kontakt nur innerhalb des 24-Stunden-Fensters, das dessen eigene Nachricht öffnet, und nur von einer Nummer, die Ihrem Workspace gehört. Siehe WhatsApp-Nachrichten senden.
  • Kategorie und Ziel bestimmen Absender und Preis. Jedes Template hat eine authentication-, utility- oder marketing-Kategorie. Ein verwaltetes Template wird von der Bird-Nummer seiner Kategorie gesendet und hat daher kein from-Feld; jeder andere Versand benennt seinen eigenen Absender. Der Preis hängt auch vom Land des Empfängers ab, und die Nachricht wird in zwei Schritten abgerechnet: die Gebühr von Bird, während Bird den Versand verarbeitet, und Metas Anteil bei Zustellung der Nachricht. Siehe Kosten und Abrechnung.

Die WhatsApp-App im Dashboard

Im Dashboard ist WhatsApp eine der Kanal-Apps des Workspace. Ihre Seiten:
SeiteZweck
MessagesEin- und ausgehende Nachrichten mit Inhalt, Events und Zustelldetails pro Nachricht
MetricsZustellmetriken für ausgehende Nachrichten und Volumen eingehender Nachrichten
TemplatesDie Templates, die Sie senden können, verwaltete und eigene: Name, Sprache, Kategorie und eine gerenderte Vorschau
NumbersVon Bird verwaltete Absendernummern und eigene verbundene Nummern
GroupsWhatsApp-Gruppen, die Ihre Geschäftsnummern verwalten, mit Teilnehmern und Einladungslinks

Sichtbarkeit

Bird zeichnet eine Timeline für jede Nachricht auf. Ausgehende Timelines umfassen Accepted-, Sent-, Delivered-, Read- und Failure-Events. Eine eingehende Timeline zeichnet auf, wann Bird die Nachricht empfangen hat.
  • Timeline lesen: GET /v1/whatsapp/messages/{message_id}/events gibt die Events der Nachricht zurück. Die Messages-Seite zeigt dieselbe Timeline. Siehe WhatsApp-Events.
  • Ausgehende Zustellevents abonnieren: Senden Sie öffentliche whatsapp.accepted-, whatsapp.sent-, whatsapp.delivered-, whatsapp.read-, whatsapp.failed- und whatsapp.rejected-Events an einen Webhook-Endpunkt.
  • Aggregierte Metriken ansehen: Die Metrics-Seite hat separate Tabs Outbound und Inbound.

Empfang

Bird speichert eingehende Nachrichten, die an eine Nummer Ihres Workspace gesendet wurden, mit dem Status received. Von Bird verwaltete Nummern empfangen keine Nachrichten für Ihren Workspace. Nachrichten finden Sie auf der Messages-Seite oder mit GET /v1/whatsapp/messages?direction=inbound. Die Nachrichtendetails zeigen Text, unterstützte Medien, Dokumente, Standorte und Inhaltstypen, die Bird nicht darstellen kann. Empfangene Medien sind 30 Tage lang verfügbar.
Der Tab Inbound auf der Metrics-Seite zeigt eine Zeitreihe Messages received und eine Aufschlüsselung By phone number. Um auf jede eingehende Nachricht bei Eintreffen zu reagieren, abonnieren Sie stattdessen das whatsapp.received-Webhook-Event; siehe WhatsApp-Events.
Manche Empfänger bitten Sie, den Versand zu stoppen. Erfassen Sie das als Unterdrückung für ein einzelnes Business-Konto oder als personenbezogenes Opt-out für den gesamten Workspace, und Bird blockiert künftige Nachrichten an die Adresse in beiden Fällen. Siehe Opt-outs.

Nächste Schritte

SeiteInhalt
WhatsApp-Nachrichten sendenDer API-Versand: Empfänger, Template, Komponenten, Tags und das asynchrone Modell
ServicenachrichtenDie neun Inhaltsarten, das Servicefenster und Medienversand per URL
EmpfangEingehende Nachrichten, Medienabruf und der whatsapp.received-Webhook
TemplatesDer Template-Katalog, Kategorien und Variablen sowie Versand per Slug
WhatsApp-LogEin- und ausgehende Nachrichten, Inhalt, Status und Event-Timelines
EventsNachrichten-Timelines und öffentliche Webhooks für ausgehende Zustellung
GruppenGemeinsame Chats mit mehreren Kunden, Einladungslinks und Gruppenlimits
Opt-outsKontobezogene Unterdrückungen, Workspace-weite Opt-outs und deren Aufhebung
WhatsApp-MetrikenAusgehende Zustellungsleistung und eingehendes Nachrichtenvolumen
Begrenzung der AnfragerateKapazität der Organisationsrichtlinie, Antwort-Header und Umgang mit 429