Zum Inhalt springen
Wbiztool

WhatsApp-Konten-API

Verbundene Nummern auflisten (API)

Rufen Sie die WhatsApp-Nummern in Ihrem Arbeitsbereich ab, die gerade verbunden sind. Nutzen Sie die API, damit Nutzer auswählen können, von welcher Nummer gesendet wird, oder um die whatsapp_client-ID für andere API-Aufrufe zu finden.

POSThttps://wbiztool.com/api/v1/whatsapp-client/list/

Body: JSON oder Formularfelder

Es werden nur verbundene Nummern zurückgegeben. Um auch getrennte Nummern zu sehen, verwenden Sie Konten auflisten.

Kurzes Beispiel#

curl -X POST https://wbiztool.com/api/v1/whatsapp-client/list/ \
  -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.

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.

Offizielle Clients verwenden#

Der Python-Client ruft diesen Endpoint für Sie auf.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.list_whatsapp_clients()
for number in result.get("whatsapp_clients", []):
    print(number["whatsapp_client_id"], number["whatsapp_client_number"])

Der Python-Client löst requests.exceptions.HTTPError aus, wenn die API HTTP 400 oder 403 zurückgibt. Umschließen Sie den Aufruf daher mit try/except.

getWhatsAppClients() im Node.js-Client ruft eine Adresse auf, die nicht existiert, und schlägt mit 404 fehl. Verwenden Sie fetch wie im Kurzen Beispiel.

Antwort#

Ein erfolgreicher Request gibt HTTP 200 zurück:

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "is_connected": true
    }
  ],
  "status": 1
}
FeldTypBeschreibung
statusinteger1 bei Erfolg, 0, wenn der Request fehlgeschlagen ist.
messagestringokay bei Erfolg, andernfalls der Fehler.
whatsapp_clientsarrayIhre verbundenen Nummern. Leer, wenn keine verbunden ist. Nur bei Erfolg vorhanden.
whatsapp_clients[].whatsapp_client_idintegerDie ID der Nummer. Übergeben Sie sie in anderen API-Aufrufen als whatsapp_client.
whatsapp_clients[].idintegerDerselbe Wert wie whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringDie Telefonnummer, wie sie beim Hinzufügen der Nummer gespeichert wurde.
whatsapp_clients[].is_connectedbooleanImmer true, da nur verbundene Nummern aufgelistet werden.

Die Liste hat keine garantierte Reihenfolge. Sortieren Sie nach whatsapp_client_id, wenn die Reihenfolge wichtig ist.

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.

Ein Request, der kein POST ist, liefert ein leeres Objekt {}. Ein unerwartetes Serverproblem liefert HTTP 500 mit einem HTML-Body. Prüfen Sie daher, ob die Antwort JSON ist, bevor Sie status auslesen.

Tipps#

  • Leere Liste: "whatsapp_clients": [] bedeutet, dass in diesem Arbeitsbereich keine Nummer verbunden ist. Verbinden Sie eine in den WhatsApp-Einstellungen oder mit Nummer verbinden.
  • Mehrere Arbeitsbereiche: Der API-Schlüssel bestimmt, welcher Arbeitsbereich aufgelistet wird. Verwenden Sie einen Schlüssel, der im gewünschten Arbeitsbereich erstellt wurde.
  • Nur eine Nummer: Um eine einzelne Nummer zu prüfen, verwenden Sie Verbindungsstatus.