WhatsApp Business Management API
Zurück zu Deutsch
Dieses Dokument wurde aktualisiert.
Die Übersetzung ins Deutsche ist noch nicht fertig.
Englisch aktualisiert: 11. Sept.

Übersicht

Mit der WhatsApp Business Management API kannst du deine Unternehmens-Assets in Zusammenhang mit WhatsApp, z. B. WhatsApp Business-Konten und Nachrichtenvorlagen, programmgesteuert verwalten. Die API baut auf die Marketing API auf und nutzt einige ihrer Endpunkte. Daher beinhaltet diese Dokumentation möglicherweise Links zur Dokumantation der Marketing API, wo zutreffend.

Anforderungen

Zugriffsschlüssel

Die Plattform unterstützt die folgenden Arten von Zugriffsschlüsseln. Welche Art du verwendest, hängt davon ab, wer deine Anwendung verwendet und ob du ein Lösungsanbieter bist.

Systemnutzer-Zugriffsschlüssel

Systemnutzer-Zugriffsschlüssel stehen für dich, dein Unternehmen oder deine Organisation bzw. für Personen innerhalb deines Unternehmens oder deiner Organisation. Der Hauptvorteil dieser Zugriffsschlüssel ist, dass sie nicht ablaufen und automatisierte Dienste innerhalb deines Unternehmens darstellen können, die keine Nutzereingaben erfordern.

Systemnutzer-Zugriffsschlüssel sind die einzige Art von Zugriffsschlüssel, die von Lösungspartnern verwendet werden können, um Kreditlinien mit aufgenommenen Kund*innen zu teilen.

Bevor du einen Systemnutzer-Zugriffsschlüssel erstellen kannst, musst du einen Systemnutzer erstellen. Die meisten Endpunkte prüfen, ob der*die durch den Zugriffsschlüssel identifizierte Nutzer*in Zugriff auf die abgefragte Ressource hat. Wenn der*die Benutzer*in keinen Zugriff auf die Ressource hat, wird die Anfrage mit dem Fehlercode 200 abgelehnt.

Systemnutzer können Mitarbeiter oder Admins sein.

Mitarbeiter-Systemnutzer

Mitarbeiter-Systemnutzern muss Zugriff auf einzelne WhatsApp-Unternehmenskonten gewährt werden, die dem Meta-Unternehmen gehören oder mit diesem geteilt werden. Wenn deine App nur auf wenige WhatsApp-Unternehmenskonten zugreifen muss, die dir gehören, sollte ein Mitarbeiter-Systemnutzer ausreichen.

Nach der Erstellung musst du jedem WhatsApp-Unternehmenskonto, auf das der Systemnutzer zugreifen muss, eingeschränkten oder uneingeschränktenZugriff auf Business-Assets gewähren.

Admin-Systemnutzer

Admin-Systemnutzer haben standardmäßig uneingeschränkten Zugriff auf alle WhatsApp-Unternehmenskonten und Assets, die dir oder deinem Unternehmen gehören oder mit dir oder deinem Unternehmen geteilt werden.

Admin-Systemnutzer sind nützlich, wenn deine App auf WhatsApp-Unternehmenskonten zugreifen muss, die neu mit deinem Unternehmen geteilt wurden. Wenn du einen Mitarbeiter-Systemnutzer verwendest, musst du manuell Business-Asset-Zugriff auf jedes WhatsApp-Unternehmenskonto gewähren, das mit dir geteilt wurde.

Beachte, dass du den Standard-Business-Asset-Zugriff eines Admin-Systemnutzers überschreiben kannst, indem du für einzelne WhatsApp-Unternehmenskonten eingeschränkten Zugriff gewährst. Unter Business-Asset-Zugriff erfährst du, wie du den Zugriff festlegst und überschreibst.

Erstellen von Systemnutzern

So erstellst du einen Systemnutzer:

  1. Melde dich bei der Meta Business Suite an.
  2. Suche dein Unternehmenskonto im Dropdown-Menü oben links und klicke auf das zugehörige Einstellungen-Symbol (Zahnrad).
  3. Klicke auf Unternehmenseinstellungen.
  4. Navigiere zu Nutzer > Systemnutzer.
  5. Klicke auf den Button Hinzufügen und erstelle einen Systemnutzer mit der Rolle Admin oder Mitarbeiter.

Generieren von Systemnutzer-Zugriffsschlüsseln

So erstellst du einen Systemnutzer-Zugriffsschlüssel, nachdem du einen Systemnutzer erstellt hast:

  1. Melde dich bei der Meta Business Suite an.
  2. Suche dein Unternehmenskonto im Dropdown-Menü oben links und klicke auf das zugehörige Einstellungen-Symbol (Zahnrad).
  3. Klicke auf Unternehmenseinstellungen.
  4. Navigiere zu Nutzer > Systemnutzer.
  5. Wähle den entsprechenden Systemnutzer aus der Liste der Systemnutzer aus.
  6. Klicke auf den Button Neuen Schlüssel generieren.
  7. Wähle die App aus, die den Schlüssel verwenden wird.
  8. Wähle alle Graph API-Berechtigungen aus, die erforderlich sind, damit die App ordnungsgemäß funktioniert, und erstelle den Schlüssel.

Business-Integration-Systemnutzer-Zugriffsschlüssel

Business-Integration-Systemnutzer-Zugriffsschlüssel sind auf einzelne aufgenommene Kund*innen beschränkt und sollten von Tech-Anbieter und Lösungspartnern beim Zugriff auf die Daten integrierter Kund*innen verwendet werden.

Diese Zugriffsschlüssel sind nützlich für Apps, die programmgesteuerte, automatisierte Aktionen für WhatsApp-Unternehmenskonten durchführen, ohne dass Eingaben von App-Nutzer*innen oder eine erneute Authentifizierung erforderlich sind.

Um einen Business-Integration-Systemnutzer-Zugriffsschlüssel zu generieren, musst du mit Facebook Login for Business konfiguriertes Embedded Signup implementieren und den Code austauschen, der an dich zurückgegeben wird, wenn ein*e Kund*in den Ablauf abschließt.

Weitere Informationen zu diesen Zugriffsschlüsseln und deren Generierung findest du im Dokument Embedded Signup und im Dokument Business-Integration-Systemnutzer-Zugriffsschlüssel.

Nutzer*innen-Zugriffsschlüssel

Nutzer*innen-Zugriffsschlüssel werden zwar unterstützt und können von allen App-Entwickler*innen verwendet werden, aber du verwendest diese wahrscheinlich nur, wenn du über das App-Dashboard deine erste Textnachricht sendest. Im Laufe der Entwicklung deiner App wirst du jedoch höchstwahrscheinlich zu einem Systemnutzer-Zugriffsschlüssel wechseln (und später zu einem Business-Systemnutzer-Zugriffsschlüssel, wenn du Tech-Anbieter oder Lösungsanbieter bist). Das liegt daran, dass Nutzer*innen-Zugriffsschlüssel schnell ablaufen, sodass du alle paar Stunden einen neuen generieren musst.

Es gibt mehrere Wege, einen Nutzer*innen-Zugriffsschlüssel zu generieren:

  • Rufe App-Dashboard > WhatsApp > Ansicht API-Setup auf. Diese Ansicht generiert bei jedem Besuch einen neuen Nutzer*innen-Zugriffsschlüssel. Der Zugriffsschlüssel wird automatisch auf deine*n Nutzer*in beschränkt, da du bei deinem Entwicklungskonto angemeldet bist, wenn du die Ansicht aufrufst.
  • Verwende den Graph API Explorer.
  • Implementiere Facebook Login.

Verwenden von Zugriffsschlüsseln in Anfragen

Füge bei API-Aufrufen deinen Zugriffsschlüssel in einen Header mit einer Autorisierungsanfrage ein und stelle Bearer voran. Zum Beispiel:

curl 'https://graph.facebook.com/v18.0/102290129340398/message_templates' \
-H 'Authorization: Bearer EAAJB...' \

Business-Asset-Zugriff

Nachdem du einen Systemnutzer erstellt hast, musst du die Ebenen für den Business-Asset-Zugriff festlegen. Bei vielen Endpunkten muss der Systemnutzer, dessen Zugriffsschlüssel in den API-Anfragen enthalten ist, auch eingeschränkten oder uneingeschränkten Business-Asset-Zugriff auf das abgefragte WhatsApp-Unternehmenskonto (oder dessen Assets) erhalten. Wenn der Systemnutzer keinen Zugriff hat, geben diese Endpunkte den Fehlercode 200 zurück.

Beachte, dass wenn du den Business-Asset-Zugriff eines Systemnutzers im WhatsApp-Unternehmenskonto auf eingeschränkten Zugriff festlegst, dass du den Zugriff auf bestimmte Assets oder Handlungen im WhatsApp-Unternehmenskonto weiter einschränken kannst. Wenn z. B. in einem großen Unternehmen eine bestimmte Abteilung nur Lesezugriff auf die Vorlage und die geschäftlichen Telefonnummern eines WhatsApp-Unternehmenskontos haben soll, könntest du einen Systemnutzer für diese Abteilung erstellen und den granularen Zugriff für diese Daten auf „Nur anzeigen“ einstellen.

So legst du den Business-Asset-Zugriff auf ein WhatsApp-Unternehmenskonto fest:

  1. Melde dich bei der Meta Business Suite an.
  2. Suche dein Unternehmenskonto im Dropdown-Menü oben links und klicke auf das zugehörige Einstellungen-Symbol (Zahnrad).
  3. Navigiere zu Konten > WhatsApp-Konten.
  4. Wähle das entsprechende WhatsApp-Unternehmenskonto aus.
  5. Wähle den Tab WhatsApp-Kontozugriff aus.
  6. Klicke auf den Button +Personen hinzufügen.
  7. Wählen Sie den entsprechenden Systemnutzer aus und weise ihm die entsprechenden Zugriffsebenen für das WhatsApp-Unternehmenskonto zu.

Testen von Endpunkten

Wir empfehlen dir die Verwendung unserer Postman-Collection oder der cURL zum Testen von Endpunkten. Du kannst zwar das Graph API Explorer-Tool verwenden, jedoch übergibt es Zugriffsschlüssel als Abfrage-String-Parameter, was wir nicht empfehlen (übergib Schlüssel stattdessen in Anfrage-Headern).

Informationen über ein Unternehmen abrufen

Um Informationen über ein Unternehmen abzurufen, sende eine GET-Anfrage an den WhatsAppBusinessAccount-Endpunkt, wobei die <WHATSAPP_BUSINESS_ACCOUNT_ID> deine WhatsApp Business Account-ID ist.

Beispielanfrage

curl -i -X GET 'https://graph.facebook.com/v21.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Beispielantwort

{
  "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
  "name": "Your WhatsApp Business Account Name",
  "timezone_id": "1",
  "message_template_namespace": "05155c78_261e_4b2f_82b3_d7958d4cf75f"
}

Um bestimmte Informationen eines Unternehmens wie den Namen, Nachrichtenvorlagen und Telefonnummern abzurufen, sende eine GET-Anfrage an den WhatsAppBusinessAccount-Endpunkt, wobei die <WHATSAPP_BUSINESS_ACCOUNT_ID> deine WhatsApp Business Account-ID ist, und lege den fields-Parameter so fest, dass eine Liste von Elementen angezeigt wird, die zurückgegeben werden sollen.

Beispielanfrage

curl -i -X GET 'https://graph.facebook.com/v21.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=id,name,message_templates,phone_numbers' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Beispielantwort

{
  "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
  "name": "Your WhatsApp Business Account Name",
  "message_templates": {
    "data": [
      {
        "name": "hello_world",
        "components": [
          {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Hello World"
          },
          {
            "type": "BODY",
            "text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform. Thank you for taking the time to test with us."
          },
          {
            "type": "FOOTER",
            "text": "WhatsApp Business Team"
          }
        ],
        "language": "en_US",
        "status": "APPROVED",
        "category": "ACCOUNT_UPDATE",
        "id": "307191531401674"
      },
      {
        "name": "sample_flight_confirmation",
        "components": [
          {
            "type": "HEADER",
            "format": "DOCUMENT"
          },
          {
            "type": "BODY",
            "text": "Confirmamos tu vuelo a {{1}}-{{2}} para el {{3}}."
          },
          {
            "type": "FOOTER",
            "text": "Este mensaje proviene de un negocio no verificado."
          }
        ],
        "language": "es",
        "status": "APPROVED",
        "category": "TICKET_UPDATE",
      },
      ...

Ratenbegrenzungen

Anfragen, die deine App an die WhatsApp Business Management API sendet, werden zur Aufrufanzahl deiner App addiert. Die Anzahl der Aufrufe einer App ist die Anzahl der Aufrufe, die die App während eines rollierenden Zeitfensters von einer Stunde durchführen kann. Für die folgende WhatsApp Business Management API kann deine App standardmäßig 200 Aufrufe pro Stunde, pro App und pro WhatsApp Business-Konto (WABA) durchführen. Für aktive WABAs mit mindestens einer registrieren Telefonnummer kann deine App 5000 Aufrufe pro Stunde, pro App und pro aktivem WABA durchführen.
Art des Aufrufs Endpunkt

GET

/{whatsapp-business-account-id}

GET, POST und DELETE

/{whatsapp-business-account-id}/assigned_users

GET

/{whatsapp-business-account-id}/phone_numbers

GET, POST und DELETE

/{whatsapp-business-account-id}/message_templates

GET, POST und DELETE

/{whatsapp-business-account-id}/subscribed_apps

GET

/{whatsapp-business-account-to-number-current-status-id}

Für die folgenden Credit Line APIs kann deine App 5000 Aufrufe pro Stunde, pro App durchführen.
Art des Aufrufs Endpunkt

GET

/{business-id}/extendedcredits

POST

/{extended-credit-id}/whatsapp_credit_sharing_and_attach

GET und DELETE

/{allocation-config-id}

GET

/{extended-credit-id}/owning_credit_allocation_configs

Um zu vermeiden, dass du deine Ratenbegrenzungen erreichste, empfehlen wir die Verwendung von Webhooks, mit denen du Statusänderungen für Nachrichten, Telefonnummern und WABAs im Auge behalten kannst.

Weitere Informationen dazu, wie du deine aktuelle Ratennutzung abrufst, findest du unter Header.

Mehr dazu

Nächste Schritte