Wir stellen die On-Premises API ein. Weitere Informationen und wie du auf unsere Cloud API der nächsten Generation migrieren kannst, findest du in unserem Dokument zur Einstellung der On-Premises API.

Senden von Nachrichtenvorlagen

Zum Senden von Nachrichtenvorlagen an deine Kunden kannst du den Endpunkt /messages verwenden. Eine Nachrichtenvorlage kann textbasiert, medienbasiert oder interaktiv sein.

Mehr über Nachrichtenvorlagen erfährst du unter Nachrichten, vom Unternehmen initiierte Nachrichten.

Bevor du beginnst

Stelle sicher, dass du die in der Dokumentation zu Nachrichten – Voraussetzungen beschriebenen Handlungen ausgeführt hast.

Schritt 1: Vorlagen mit WhatsApp Manager erstellen

Nachrichtenvorlagen werden in WhatsApp Manager erstellt, der Teil deines WhatsApp-Kontos in Facebook Business Manager ist. Deine Nachrichtenvorlagen werden überprüft, um sicherzustellen, dass sie nicht gegen die WhatsApp-Richtlinien verstoßen. Nach der Genehmigung verfügt dein Unternehmen über einen eigenen Namespace, in dem sich die Nachrichtenvorlagen befinden.

Zur Erstellung einer Nachrichtenvorlage wird Folgendes benötigt:

  1. Name der Nachrichtenvorlage: Darf nur alphanumerische Kleinbuchstaben und Unterstriche (_) enthalten. Andere Zeichen oder Leerzeichen sind nicht erlaubt.
  2. Komponenten der Nachrichtenvorlage — Gib in die Vorlage gegebenenfalls den Text und/oder die Medienkomponenten ein, inklusive Parameter-Platzhalter. Stelle sicher, dass keine Zeilenwechsel, Tabulatoren oder mehr als 4 aufeinanderfolgende Leerzeichen enthalten sind und dass die Längenbeschränkung eingehalten wird, wie im Business Manager oder der WhatsApp Business Management API festgelegt.
  3. Alle anderen Übersetzungen, die dein Unternehmen wünscht.

Bei der Erstellung einer Nachrichtenvorlage kannst du mit einem Klick auf den Button Beispiel hinzufügen eine Beispielvorlage hinzufügen. Das hilft uns während des Überprüfungs- und Genehmigungsprozesses dabei zu verstehen, welche Art Nachricht du senden möchtest. Stelle sicher, dass dies Beispiele sind, und gib keine vertraulichen oder personenbezogenen Informationen an.

Detaillierte Schritte zur Erstellung von Nachrichtenvorlagen findest du unter Nachrichtenvorlagen für deine WhatsApp Business API-Konto erstellen.

Beispiele

Erstellen einer Begrüßungsnachricht, bei der der Name der Nachrichtenvorlage welcome und die Nachricht wie folgt lautet:

  "Welcome {{1}}. We look forward to serving you on WhatsApp." 

Erstellen einer Nachricht zur Auftragsbestätigung, bei der der Name der Nachrichtenvorlage order_confirmation und die Nachricht wie folgt lautet:

  "Your order {{1}} for a total of {{2}} is confirmed. The expected delivery is {{3}}." 

Übersetzungen

WhatsApp fertigt keine Übersetzungen für dein Unternehmen an. Alle Übersetzungen von Nachrichtenvorlagen müssen von dir im hier erläuterten Format eingegeben werden. Der Elementname ist für alle Übersetzungen gleich. Weitere Informationen findest du hier:

Schritt 2: POST-Anforderung an /messages erstellen

Sobald du deine Vorlage erstellt hast, kann du sie mit dem template-Objekt an deine Kund*innen senden:

POST /v1/messages
{
  "to": "recipient_wa_id",
  "type": "template",
  "template": {
        "namespace": "your-namespace",
        "name": "your-template-name",
        "language": {
            "code": "your-language-and-locale-code",
            "policy": "deterministic"
        },
        "components": [{
            "type": "body",
            "parameters": [
                {
                    "type": "text",
                    "text": "your-text-string"
                },
                {
                    "type": "currency",
                    "currency": {
                        "fallback_value": "$100.99",
                        "code": "USD",
                        "amount_1000": 100990
                    }
                },
                {
                    "type": "date_time",
                    "date_time" : {
                        "fallback_value": "February 25, 1977",
                        "day_of_week": 5,
                        "day_of_month": 25,
                        "year": 1977,
                        "month": 2,
                        "hour": 15,
                        "minute": 33
                    }
                },
                {
                "type": "date_time",
                    "date_time" : {
                    "fallback_value": "February 25, 1977",
                    "timestamp": 1485470276
                    }
                }
            ]
        }]
    }
}

Es werden nur die Button-Typen URL, QUICK_REPLY und PHONE_NUMBER unterstützt.

Wenn eine Vorlage einen Button-Typ enthält, der nicht in dieser Liste aufgeführt ist, gibt die API einen Fehler zurück.

Parameter

Schritt 3: API-Antwort prüfen

Eine erfolgreiche Antwort beinhaltet ein messages-Objekt mit einer id.

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}  

Wenn der Vorgang fehlschlägt, enthält die Antwort ein Fehlerobjekt, das eine Fehlerzeichenfolge, einen Fehlercode und andere Informationen umfasst. Weitere Informationen dazu findest du unter Fehler- und Statuscodes.

Nachrichtenbeschränkungen für Marketingvorlagen pro Benutzer*in

Ab dem 6. Februar 2024 gelten die Nachrichtenbeschränkungen für Marketingvorlagen pro Benutzer*in für Vorlagennachrichten, die an eine kleine Anzahl von WhatsApp-Benutzer*innen in Indien gesendet werden. Bis zum 13. Februar 2024 gelten sie jedoch für alle WhatsApp-Benutzer*innen mit einer indischen Telefonnummer.

Wir führen neue Ansätze ein, beginnend mit Verbraucher*innen in Indien, die hochwertige Benutzungserlebnisse schaffen und das Engagement von Marketingvorlagennachrichten maximieren. Dazu gehört unter anderem, die Anzahl der Marketingvorlagennachrichten, die eine Person in einem bestimmten Zeitraum von einem Unternehmen erhält, zu begrenzen, beginnend mit einer kleinen Anzahl von Unterhaltungen, die weniger wahrscheinlich gelesen werden. Beachte, dass die Beschränkung auf der Grundlage der Anzahl der Marketingvorlagennachrichten bestimmt wird, die die Person bereits von einem Unternehmen erhalten hat, und sich nicht speziell auf dein Unternehmen bezieht.

Die Beschränkung gilt nur für Marketing-Vorlagennachrichten, die normalerweise eine neue Marketing-Unterhaltung eröffnen würden. Wenn bereits eine Marketing-Unterhaltung zwischen dir und einem*einer WhatsApp-Benutzer*in geöffnet ist, sind die an den*die Benutzer*in gesendeten Marketingvorlagennachrichten nicht betroffen.

Wenn eine Marketingvorlagennachricht aufgrund der Beschränkung nicht an eine*n bestimmte*n Benutzer*in übermittelt wird, gibt die On-Premises API den Fehlercode 1026 zurück. Beachte jedoch, dass dieser Fehlercode ein breites Spektrum an Problemen abdeckt, die dazu führen können, dass eine Nachricht nicht zugestellt wird. Aus Datenschutzgründen geben wir nicht bekannt, ob die Nachricht aufgrund der Beschränkung nicht zugestellt wurde. Siehe „Warum beträgt meine Auslieferungsrate nicht 100 %?“ FAQ für weitere Informationen.

Wenn du einen dieser Fehlercodes erhältst und vermutest, dass er auf die Beschränkung zurückzuführen ist, vermeide es, die Vorlagennachricht sofort erneut zu senden, da dies nur zu einer weiteren Fehlerantwort führt. Versuche es stattdessen in immer größeren Zeitschritten erneut, bis die Nachricht zugestellt wird, da die Beschränkung für unterschiedliche Zeiträume gelten kann.

Wir werden unseren Ansatz weiter verfeinern und schätzen deine Partnerschaft, während wir in die bestmögliche Erfahrung von WhatsApp für dein Unternehmen und deine Kund*innen investieren.