Telefonnummern abrufen

Rufe mit der WhatsApp Business Management API Telefonnummern ab, die ein Unternehmen für sein WhatsApp Business-Konto registriert hat.

Bevor du beginnst

Voraussetzungen:

• Die WhatsApp Business Account-ID für die Telefonnummern des Unternehmens, die du abrufen möchtest
• Einen Systembenutzer-Zugriffsschlüssel, der mit deinem WhatsApp Business Account verknüpft ist
• Die Berechtigung whatsapp_business_management

Einschränkungen

• Diese API kann nur Telefonnummern abrufen, die registriert wurden. Mit der API dürfen keine Telefonnummern hinzugefügt, aktualisiert oder gelöscht werden.

Alle Telefonnummern abrufen

Um eine Liste aller Telefonnummern abzurufen, die mit einem WhatsApp Business-Konto verknüpft sind, sende eine GET-Anfrage an den Endpunkt WhatsApp Business-Konto > Telefonnummern.

Telefonnummern können außerdem in auf- oder absteigender Reihenfolge nach last_onboarded_time sortiert werden. Dieser Wert basiert auf dem Zeitpunkt, zu dem ein*e Nutzer*in die Freischaltung für Embedded Signup abgeschlossen hat. Wird kein Wert angegeben, erfolgt die Sortierung standardmäßig in absteigender Reihenfolge.

Beispielanfrage

curl -X GET "https://graph.facebook.com/v19.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}"

Bei Erfolg wird ein JSON-Objekt mit einer Liste aller Unternehmensnamen, Telefonnummern, Telefonnummern-IDs und Qualitätsbewertungen zu einem Unternehmen zurückgegeben. Die Ergebnisse werden nach dem Abschlussdatum des Embedded Signup in absteigender Reihenfolge sortiert. Dabei werden die zuletzt freigeschalteten zuerst aufgeführt.

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
      
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

Beispielanfrage

curl -X GET "https://graph.facebook.com/v19.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}]&sort=['last_onboarded_time_ascending']"

Bei Erfolg wird ein JSON-Objekt mit einer Liste aller Unternehmensnamen, Telefonnummern, Telefonnummern-IDs und Qualitätsbewertungen zu einem Unternehmen zurückgegeben. Die Ergebnisse werden nach dem Abschlussdatum des Embedded Signup in aufsteigender Reihenfolge sortiert. Dabei werden die zuletzt freigeschalteten als letztes aufgeführt.

{
  "data": [
   {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    },
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"     
    }   
  ]
}

Telefonnummern filtern

Du kannst Telefonnummern abfragen und sie basierend auf ihrem account_mode filtern. Diese Filteroption wird derzeit in der Beta-Version getestet. Nicht alle Entwickler*innen haben Zugriff auf diese Option.

Parameter

Beispielanfrage

curl -i -X GET "https://graph.facebook.com/v19.0/{whatsapp-business-account-ID}/phone_numbers?filtering=[{"field":"account_mode","operator":"EQUAL","value":"SANDBOX"}]&access_token=access-token"

Beispielantwort

{
  "data": [
    {
      "id": "1972385232742141",    
      "display_phone_number": "+1 631-555-1111",
      "verified_name": "John’s Cake Shop",
      "quality_rating": "UNKNOWN",
    }
  ],
  "paging": {
	"cursors": {
		"before": "abcdefghij",
		"after": "klmnopqr"
	}
   }
}

Eine einzelne Telefonnummer abrufen

Um Informationen über eine Telefonnummer abzurufen, sende eine GET-Anfrage an den Endpunkt WhatsApp Business-Telefonnummer:

Anfragesyntax

GET https://graph.facebook.com/<API_VERSION>/<PHONE_NUMBER_ID>

Beispielanfrage

curl \
'https://graph.facebook.com/v15.0/105954558954427/' \
-H 'Authorization: Bearer EAAFl...'

Bei Erfolg wird ein JSON-Objekt mit dem Unternehmensnamen, der Telefonnummer, der Telefonnummern-ID und einer Qualitätsbewertung für die Telefonnummer zurückgegeben.

{
  "code_verification_status" : "VERIFIED",
  "display_phone_number" : "15555555555",
  "id" : "105954558954427",
  "quality_rating" : "GREEN",
  "verified_name" : "Support Number"
}

Status des Anzeigenamens abrufen (Beta)

Beziehe fields=name_status als Abfrageparameter ein, um den Status eines Anzeigenamens, der mit einer bestimmten Telefonnummer verknüpft ist, abzufragen. Dieses Feld befindet sich derzeit in der Beta-Phase und steht nicht allen Entwickler*innen zur Verfügung.

Beispielanfrage

curl \
'https://graph.facebook.com/v15.0/105954558954427?fields=name_status' \
-H 'Authorization: Bearer EAAFl...'

Beispielantwort

{
  "id" : "105954558954427",
  "name_status" : "AVAILABLE_WITHOUT_REVIEW"
}

Der name_status-Wert kann einer der folgenden sein:

• APPROVED: Der Name wurde genehmigt. Du kannst dein Zertifikat jetzt herunterladen.
• AVAILABLE_WITHOUT_REVIEW: Das Zertifikat für dieses Telefon ist verfügbar und der Anzeigename kann ohne Überprüfung verwendet werden.
• DECLINED: Der Name wurde nicht genehmigt. Du kannst dein Zertifikat nicht herunterladen.
• EXPIRED: Dein Zertifikat ist abgelaufen und du kannst es nicht mehr herunterladen.
• PENDING_REVIEW: Deine Namensanfrage wird geprüft. Du kannst dein Zertifikat nicht herunterladen.
• NONE: Es ist kein Zertifikat verfügbar.

Beachte, dass Zertifikate für sieben Tage gültig sind.

Mehr dazu

Eine Liste der möglichen Werte für die einzelnen Felder findest du in der Graph API-Referenz für das Telefonnummernfeld.