Zum Inhalt springen
Wbiztool

WhatsApp-Konten-API

WhatsApp-Konten auflisten (WhatsApp Accounts API)

Mit dieser API erhalten Sie in einem einzigen Aufruf eine vollständige Liste all Ihrer WhatsApp-Nummern und ihres Verbindungsstatus. Anders als Verbundene Nummern auflisten enthält sie auch getrennte Nummern.

POSThttps://wbiztool.com/api/v1/whatsapp/accounts/

Body: JSON oder Formularfelder

UnterschiedKonten auflistenVerbundene Nummern auflisten
Enthält getrennte und gelöschte NummernJaNein
Schlüssel der Einträgewhatsapp_client_id, whatsapp_number, statusid, whatsapp_client_id, whatsapp_client_number, is_connected
message bei ErfolgNicht enthaltenokay

Kurzes Beispiel#

curl -X POST https://wbiztool.com/api/v1/whatsapp/accounts/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY"
  }'

Ersetzen Sie 12345 und YOUR_API_KEY durch Ihre eigenen Werte. Wo Sie diese finden, steht unter Authentifizierung.

Keiner der offiziellen Clients hat eine Methode für diesen Endpoint. Rufen Sie ihn daher direkt auf, wie in den Beispielen.

Request-Parameter#

client_idintegererforderlich

Ihre API-Client-ID aus Einstellungen → API-Schlüssel.

api_keystringerforderlich

Ihr API-Schlüssel von derselben Seite. Die Liste gilt für den Arbeitsbereich, in dem dieser Schlüssel erstellt wurde.

Antwort#

Ein erfolgreicher Request gibt HTTP 200 zurück:

{
  "whatsapp_clients": [
    {
      "whatsapp_client_id": 678,
      "whatsapp_number": "919876543210",
      "status": "connected"
    },
    {
      "whatsapp_client_id": 702,
      "whatsapp_number": "919812345678",
      "status": "not_connected"
    }
  ],
  "status": 1
}
FeldTypBeschreibung
statusinteger1 bei Erfolg, 0, wenn der Request fehlgeschlagen ist.
whatsapp_clientsarrayJede WhatsApp-Nummer, die jemals zu diesem Arbeitsbereich hinzugefügt wurde. Nur bei Erfolg vorhanden.
whatsapp_clients[].whatsapp_client_idintegerDie ID der Nummer. Übergeben Sie sie in anderen API-Aufrufen als whatsapp_client.
whatsapp_clients[].whatsapp_numberstringDie Telefonnummer, wie sie beim Hinzufügen gespeichert wurde.
whatsapp_clients[].statusstringconnected oder not_connected.

Die Liste ist nicht in einer garantierten Reihenfolge sortiert. Sortieren Sie nach whatsapp_client_id, wenn die Reihenfolge wichtig ist.

Eine erfolgreiche Antwort hat kein Feld message. Lesen Sie es daher wie in den Beispielen mit einem Fallback aus.

Fehler#

MeldungHTTPLösung
Auth Error200Senden Sie client_id und api_key in einem POST-Body, als gültiges JSON oder als Formularfelder.
Invalid Client Id403Senden Sie client_id als ganze Zahl, zum Beispiel 12345.
Auth Error: invalid api key400Prüfen Sie, ob der Schlüssel existiert, nicht gelöscht wurde und zu dieser client_id gehört.

Tritt auf dem Server ein unerwartetes Problem auf oder ist der Request kein POST, ist die Antwort ein leeres Objekt: {}. Behandeln Sie ein fehlendes status als Fehler.

Tipps#

  • Nummer erneut verbinden: Eine Nummer mit not_connected können Sie in den WhatsApp-Einstellungen oder mit Nummer verbinden erneut verbinden.
  • Nur eine Nummer: Um eine einzelne Nummer zu prüfen, verwenden Sie Verbindungsstatus.
  • Mehrere Arbeitsbereiche: Der API-Schlüssel bestimmt, welcher Arbeitsbereich aufgelistet wird. Verwenden Sie einen Schlüssel, der im gewünschten Arbeitsbereich erstellt wurde.