WhatsApp Vorlagenverwaltung API

Die API für die Verwaltung von WhatsApp-Vorlagen ermöglicht es Ihnen, vorhandene WhatsApp-Vorlagen aufzulisten, neue Vorlagen zu erstellen, Vorlagen zu löschen und Medien zur Verwendung in Vorlagen hochzuladen. Obwohl WhatsApp-Vorlagen manuell über die API verwaltet werden können WhatsApp Business Manager UI können Sie mit der Vonage WhatsApp Template Management API Ihre Vorlagen jetzt programmatisch über die WhatsApp Business API verwalten.

Mit der API für die Verwaltung von WhatsApp-Vorlagen können Sie derzeit die folgenden Vorgänge durchführen:

WhatsApp unterstützt derzeit nicht das Senden von Kontakten und Orten innerhalb einer Nachrichtenvorlage. Diese Nachrichten können nur als Antwort auf eine eingehende Nachricht gesendet werden.

Die WhatsApp Template Management API Rate ist auf 40rps begrenzt.

Abrufen einer Liste von Vorlagen

Mit der WhatsApp Template Management API können Sie eine Liste der Vorlagen abrufen, die dem angegebenen WhatsApp Business Account gehören. Die API bietet einige Funktionen zur Paginierung und Filterung. Zum Beispiel können Sie Anfragen nach Vorlagen filtern status, languageund name_or_content.

Eine Vorlage erstellen

Sie können Vorlagen verschiedener Typen und Kategorien sowie mehrere Sprachvarianten einer Vorlage erstellen. Wenn Sie Vorlagen mit mehreren Sprachversionen erstellen, achten Sie darauf, dass die Übersetzungen in allen Versionen konsistent sind.

Stellen Sie sicher, dass Ihre Vorlagen Richtlinien für WhatsApp-Nachrichtenvorlagen. Werden die Leitlinien nicht korrekt befolgt, kann dies Auswirkungen auf die Vorlagen haben, die genehmigt.

Beachten Sie, dass die Anforderungen an den Inhalt und die Zusammensetzung einer Vorlage je nach Vorlage variieren Kategoriewobei die Authentifizierungsvorlagen am stärksten eingeschränkt sind und die Marketingvorlagen am flexibelsten sind. Die Meta-Dokumentation enthält weitere Informationen darüber, was für die verschiedenen Vorlagenkategorien zulässig ist.

Genehmigungsverfahren

Vorlagen müssen von Meta genehmigt werden, bevor sie in einer WhatsApp-Nachricht verwendet werden können. Wenn sie erstellt werden, haben Vorlagen zunächst eine status von PENDING. Nach der Genehmigung erhalten sie eine status von APPROVEDund kann dann verwendet werden.

Vorlagen für Medienmitteilungen

Wenn Sie Vorlagen für Mediennachrichten erstellen, müssen Sie zunächst die zu verwendenden Medien auf die WhatsApp-Plattform hochladen (siehe Hochladen von Medien). Hochgeladene Medien haben einen eindeutigen Handle, der bei der Erstellung einer Vorlage angegeben werden kann.

Sprachvariationen

Sie können mehrere Varianten einer Vorlage erstellen, um verschiedene Sprachen zu berücksichtigen. Erstellen Sie dazu eine Vorlage mit der gleichen name und category als eine bestehende Vorlage und setzen Sie language Eigenschaft und den gesamten Textinhalt entsprechend der neuen Sprachvariante. Eine Liste der unterstützten Sprachen finden Sie in der WhatsApp-Dokumentation.

Vorlage Kategorien

Ab dem 1. Juni 2023 führt WhatsApp neue Konversationskategorien für Unternehmen ein, die Nachrichten versenden; Informationen zu diesen Kategorien und ihren Preisen finden Sie hier hier. Es gibt jetzt drei unterstützte Vorlagentypen für jeden der vom Unternehmen initiierten Konversationstypen:

  • UTILITY: Ermöglichung des Abschlusses einer bestimmten, vereinbarten Anfrage oder Transaktion oder Information des Kunden über eine laufende Transaktion, einschließlich Benachrichtigungen nach dem Kauf und regelmäßige Abrechnungen.
  • AUTHENTICATION: Ermöglicht Unternehmen die Verwendung von Einmal-Passcodes zur Verifizierung von Nutzern in verschiedenen Anmeldestufen, falls erforderlich (z. B. Account-Verifizierung, Account-Wiederherstellung, Integritätsherausforderungen).
  • MARKETING: Von Unternehmen initiierte Konversationen zur Vermarktung einer Ware oder Dienstleistung an Kunden, z. B. das Versenden einschlägiger Angebote an Kunden, die sich dafür angemeldet haben. Dies würde auch jede geschäftsbezogene Interaktion einschließen, die keine Authentifizierungs- oder Versorgungskonversation ist.

Alle bestehenden Vorlagen in einer dieser Kategorien werden in eine der neuen Vorlagenkategorien migriert: TRANSACTIONAL, MARKETING, OTP, ACCOUNT_UPDATE, PAYMENT_UPDATE, PERSONAL_FINANCE_UPDATE, SHIPPING_UPDATE, RESERVATION_UPDATE, ISSUE_RESOLUTION, APPOINTMENT_UPDATE, TRANSPORTATION_UPDATE, TICKET_UPDATE, ALERT_UPDATE oder AUTO_REPLY.

Hinweis: Ein nicht verifizierter WhatsApp Business Account kann maximal 250 Nachrichtenvorlagen haben, während ein verifiziertes Geschäftskonto kann bis zu 6000 Nachrichtenvorlagen haben. Jede Sprachvariante zählt als eine Vorlage, z. B. eine Nachrichtenvorlage namens hello_world in zwei Sprachen übersetzt wird, zählt in Bezug auf diese Grenze als zwei Nachrichtenvorlagen.

Ein WhatsApp Business Account kann maximal 100 Nachrichtenvorlagen pro Stunde erstellen.

Löschen einer Vorlage

Sie können eine Vorlage löschen, die mit einem bestimmten WhatsApp Business Account verbunden ist, indem Sie die Vorlage mit ihrem Namen oder ihrer ID angeben. Wenn eine bestimmte Vorlage mehrere Sprachversionen mit demselben Namen hat, alle Versionen für diesen Vorlagennamen werden gelöscht.

Nach dem Löschen kann der Name der (genehmigten) Vorlage 30 Tage lang nicht mehr verwendet werden.

Für eine gelöschte Vorlage gesendete Nachrichten können noch zugestellt werden innerhalb 30 Tage, wenn sie bereits verschickt, aber noch nicht zugestellt wurden.

Aktualisieren einer Vorlage

Sie können eine bestehende Vorlage aktualisieren, die über ihre Vorlagen-ID identifiziert wird. Bei der Bearbeitung einer Vorlage sind einige Dinge zu beachten:

  1. Nachrichtenvorlagen können nur bearbeitet werden, wenn sie in einer Approved, Rejected, oder Paused Zustand.
  2. Wenn Sie eine Live-Vorlage bearbeiten, können Sie die Vorlagen automatisch genehmigen lassen. Vorlagen, die die Prüfungen der Formatierung und der Geschäfts- und Handelsrichtlinien bestehen, werden sofort wieder live geschaltet, ohne dass weitere Maßnahmen erforderlich sind, um den Versand von Nachrichten fortzusetzen, die diese Vorlagen bereits verwenden.
  3. Bei der Bearbeitung einer Paused Vorlage werden Vorlagen für die automatische Genehmigung in Frage kommen. Vorlagen, die die Formatierungsprüfungen und die Prüfungen der Geschäfts- und Handelsrichtlinien bestehen, können wieder live geschaltet werden. Um mit dem Versand von Nachrichten unter Verwendung dieser Vorlagen zu beginnen, müssen Unternehmen einen API-Aufruf an die Messaging-API richten.
  4. Mit dem Endpunkt "Update" können Sie die Kategorie der Vorlage ändern. Sobald die Anfrage erfolgreich übermittelt wurde, können Sie sowohl die "previous_category" als auch die aktualisierte "category" sehen, wenn Sie den Endpunkt "List Templates" verwenden.
  5. Nachrichtenvorlagen im Status "Genehmigt" können innerhalb von 30 Tagen bis zu 10 Mal bzw. innerhalb von 24 Stunden bis zu 1 Mal bearbeitet werden. Nachrichten im Status "Abgelehnt" oder "Angehalten" können beliebig oft bearbeitet werden.

Hochladen von Medien

Sie können Medien wie Bilder, Videos und PDF-Dateien auf die WhatsApp-Plattform hochladen, um sie in Mediennachrichtenvorlagen zu verwenden. Die Medien müssen hochgeladen werden, bevor sie in einer Mediennachrichtenvorlage verwendet werden können.

Hinweis: Es kann zu einer Zeitüberschreitung kommen, wenn Sie versuchen, große Mediendateien (z. B. über 25 MB) hochzuladen. In solchen Fällen empfehlen wir, stattdessen die WhatsApp Business Manager UI zu verwenden, um die Dateien hochzuladen.

Beispiel einer cURL-Anfrage

curl --location 'https://api.nexmo.com/v2/whatsapp-manager/media/uploads?file_type=image%2Fjpg' \
--header 'Authorization: Basic NTE1...g==' \
--form 'mediafile=@"Directory/WhatsApp_Image.jpeg"'