WhatsApp Business Platform On-Premises API

Account

/v1/account

Wir stellen die On-Premises API ein. Dieser Endpunkt kann nicht mehr für die Registrierung geschäftlicher Telefonnummern verwendet werden und gibt nun den folgenden Fehler zurück:

{
  "code": 1005,
  "title": "Access denied",
  "details": "Unknown error: biz_link_on_prem_reg_blocked"
}

Der Node account dient zum Registrieren deines WhatsApp Business API-Clients.

Beachte, dass die Coreapp neu gestartet wird, wenn in einem Cluster, für das bereits eine andere Nummer registriert ist, eine neue Nummer registriert wird.

Edges

Die folgenden Edges sind mit diesem Node verbunden:

EdgeBeschreibung

/verify

Nachdem du den Registrierungscode mit der angegebenen Methode erhalten hast, verwendest du diese Edge, um die Kontoregistrierung abzuschließen.

Bevor du beginnst

Voraussetzungen:

Base64-codiertes Zertifikat kopieren

Ein Base64-codierter Zertifikatstring wird generiert. Er wird für die Validierung während der Registrierung des WhatsApp Business API-Clients benötigt.

  1. Gehe zu Unternehmenseinstellungen im Meta Business Manager.
  2. Klicke im Menü Konten auf WhatsApp-Konten. Wähle dann dein WhatsApp-Konto in der Liste WhatsApp-Konten aus, falls es noch nicht hervorgehoben ist.
  3. Gehe zum Tab Einstellungen und klicke auf den Button WhatsApp Manager.
  4. Im Tab Telefonnummern müsstest du deine Telefonnummern sehen. Klicke neben der Telefonnummer, für die das Zertifikat abgerufen werden soll, auf Anzeigen.
    Zertifikat abrufen
  5. Ein Popup-Dialog mit dem Zertifikatstring in einem grauen Feld wird geöffnet. Klicke auf Zertifikat abrufen.
    Zertifikatstring herunterladen
  6. Verwende diesen Zertifikatstring im Parameter cert, wenn du dich beim Endpunkt account registrierst.

Weitere Informationen findest du in der Dokumentation zu Display-Namen.

Einschränkungen

  • Du musst die Anwendung über das admin-Konto registrieren.
  • Wenn du dein Konto erneut registrierst, muss die Coreapp nach Abschluss der Registrierung neu gestartet werden.

Anfordern

Sende zum Anfordern eines Registrierungscodes einen POST-Aufruf an diesen Endpunkt. Füge im Aufruf deine Telefonnummer und den base64-codierten Zertifikatstring hinzu. Du kannst den Code per SMS oder Sprachanruf erhalten.

Beispiel

POST /v1/account

{
    "cc": "COUNTRY_CODE",
    "phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
    "method": "sms" or "voice",
    "cert": "VERIFIED_NAME_CERT_IN_BASE64",
    "pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}

Die empfangene Antwort zeigt an, ob der Registrierungsvorgang beendet oder ein weiterer Schritt notwendig ist. Wenn der Vorgang erfolgreich ist, erhältst du einen der folgenden HTTP-Statuscodes: Befolge die Anweisungen für die empfangene Antwort:

  • 201 Created – Das Konto ist bereits vorhanden. Du bist bereits registriert, brauchst also nichts mehr zu tun.
  • 202 Accepted – Das Konto ist nicht vorhanden. Prüfe abhängig von der in der Anforderung gewählten Methode, ob der Registrierungscode per SMS oder Sprachanruf übermittelt wurde. Die Antwort enthält eine Payload mit dem vname, der aus dem Parameter cert decodiert wurde. So kannst du erkennen, ob der richtige Display-Name verwendet wird. Wenn dies der richtige Name ist, schließt du die Registrierung wie unter Abschließen der Kontoregistrierung beschrieben ab.
{
  "account": [{
      "vname": "decoded-vname-from-cert"
  }]
}

Wenn Fehler zurückgegeben werden, findest du weitere Informationen unter Fehlercodes und Statusmeldungen.

Parameter

NameBeschreibung

cc

Erforderlich.

Numerische Landesvorwahl der Telefonnummer, die du registrierst

phone_number

Erforderlich.

Telefonnummer, die du registrierst, allerdings ohne Landesvorwahl oder Pluszeichen (+)

method

Erforderlich.

Methode für den Empfang des Registrierungscodes
Optionen:voice, sms

cert

Erforderlich.

Base64-codiertes Zertifikat.

pin

Optional

Vorhandene sechsstellige PIN – ist nur erforderlich, wenn die Verifizierung in zwei Schritten bei diesem Konto aktiviert ist.

Ändern deiner PIN für die Verifizierung in zwei Schritten

So änderst du die PIN für die Verifizierung deiner Unternehmenstelefonnummer in zwei Schritten:

  1. Rufe dein Business-Portfolio im WhatsApp Manager auf.
  2. Wenn das Panel Telefonnummern nicht automatisch geladen wird, navigiere zu Kontofunktionen (das Werkzeugkastensymbol) > Telefonnummern.
  3. Klicken Sie auf das Einstellungssymbol (Zahnrad) der Telefonnummer.
  4. Klicke auf Verifizierung in zwei Schritten.
  5. Klicke auf PIN ändern und schließe den Vorgang ab.

Zur PIN-Änderung ist die Angabe deiner aktuellen PIN erforderlich. Beachten, dass du auch über unsere APIs eine neue PIN festlegen kannst:

Deaktivieren der Verifizierung in zwei Schritten

Um die Verifizierung in zwei Schritten zu deaktivieren, befolge die Schritte zum Ändern deiner PIN, klicke jedoch stattdessen beim letzten Schritt auf den Button Verifizierung in zwei Schritten deaktivieren . Eine E-Mail mit einem Link wird an die E-Mail-Adresse gesendet, die deinem Business-Portfolio zugeordnet ist. Verwende den Link, um die Verifizierung in zwei Schritten zu deaktivieren. Sobald du die Funktion deaktiviert hast, kannst du sie erneut aktivieren, indem du eine neue PIN festlegst.

FAQs

Ja, wir können eine neue Telefonnummer einrichten oder den Verified Name ändern, sobald du für die Live-Übertragung bereit bist.

Permalink

Gebührenfreie Nummern sind erlaubt, solange die Landesvorwahl enthalten ist. Der Grund dafür ist, dass gebührenfreie Nummern ohne Landesvorwahl nicht eindeutig identifiziert werden können, sodass die gleiche Nummer für zwei verschiedene Länder gelten kann.

Außerdem ist zu beachten, dass mit den gebührenfreien Nummern zusätzliche Schwierigkeiten verbunden sind. In der Regel schlägt der Anruf einer gebührenfreien Nummer mit der Landesvorwahl fehl, wenn sich der Anrufer innerhalb des Landes befindet. Es kann also sein, dass deine Kunden aus deinem Land versuchen, die im Geschäftskontakt angezeigte Nummer (einschließlich der Landesvorwahl) zu wählen, und sie dich nicht erreichen können. Wenn dies ein Problem darstellt, musst du es ihnen explizit mitteilen.

Hier erfährst du mehr über gebührenfreie Nummern.

Permalink

Wenn du das aktuelle Setup sicherst und es auf dem neuen Gerät wiederherstellst, sollten die Registrierungsinformationen mit dem Rest deiner Implementierung übernommen werden. Weitere Informationen findest in der Dokumentation Einstellungen zur Sicherung und Wiederherstellung.

Permalink

In deinem WhatsApp-Konto im Facebook Business Manager kannst du neue Telefonnummern registrieren und alte löschen.

  1. Rufe in deinem WhatsApp-Konto Einstellungen aus.
  2. Klicke auf WhatsApp Manager.
  3. Wähle den Tab Telefonnummern. Hier kannst du sämtliche Telefonnummern für dieses Konto verwalten.
Permalink

Wenn die Registrierung mit „SMS“ aufgrund zu vieler Versuche fehlschlägt und dir die Meldung „Zugriff verweigert“ angezeigt wird, versuche bitte, die Registrierung per Sprachanruf durchzuführen.

Permalink

Du musst leider eine andere Telefonnummer wählen, die SMS oder Sprachanrufe empfangen kann, damit wir den Registrierungscode senden können. In der Vergangenheit haben wir manuelle Registrierungscodes erlaubt, aber diese werden nicht mehr unterstützt. Telefonnummern, für die zuvor manuelle Registrierungscodes verwendet wurden, werden bei Bedarf weiterhin unterstützt. Bei neuen Telefonnummern übermitteln wir Registrierungscodes nur per SMS oder Sprachanruf.

Wenn du deine 1800-Nummer oder gebührenfreie Nummer verwenden möchtest, lies bitte diesen Leitfaden.

Permalink

Mehr erfahren