Zum Inhalt springen
Wbiztool

Erste Schritte

Erste Schritte mit der Wbiztool-API

Mit der REST-API von Wbiztool sendet Ihre Software WhatsApp-Nachrichten von Ihrer eigenen verbundenen WhatsApp-Nummer. Nutzen Sie sie, um Bestellupdates, Erinnerungen und Benachrichtigungen aus Ihrer App, Ihrem CRM, Ihrer Website oder Ihrem Automatisierungstool zu senden.

Diese Seite beschreibt, was jeder Request benötigt. Um Ihre erste Nachricht zu senden, springen Sie direkt zu Nachricht senden.

Basis-URL#

Alle Endpoints liegen unter:

https://wbiztool.com/api/v1/

Die meisten Endpoints akzeptieren POST-Requests. Sie können den Body als JSON (application/json) oder als Formularfelder (application/x-www-form-urlencoded) senden. Zum Hochladen einer Datei verwenden Sie multipart/form-data. Einige lesende Endpoints verwenden GET; die Seite jedes Endpoints nennt die Methode.

Bevor Sie beginnen#

  1. Erstellen Sie ein Konto unter wbiztool.com/signup. Neue Konten enthalten 50 kostenlose Nachrichten.
  2. Verbinden Sie eine WhatsApp-Nummer. Öffnen Sie die WhatsApp-Einstellungen, klicken Sie auf „Verbinden“ und scannen Sie den QR-Code mit WhatsApp auf Ihrem Smartphone.
  3. Erstellen Sie einen API-Schlüssel. Gehen Sie zu Einstellungen → API-Schlüssel. Nur der Inhaber eines Arbeitsbereichs kann Schlüssel erstellen. Jeder Arbeitsbereich kann bis zu 10 Schlüssel haben.

Authentifizierung#

Die meisten Endpoints erwarten Ihre Zugangsdaten im Body jedes Requests. Die Verifizierungs-API verwendet stattdessen einen Authorization: Bearer-Header; die zugehörigen Seiten erklären das.

client_idintegererforderlich

Ihre API-Client-ID, angezeigt unter Einstellungen → API-Schlüssel.

api_keystringerforderlich

Einer Ihrer API-Schlüssel von derselben Seite. Halten Sie ihn geheim: Wer den Schlüssel hat, kann Nachrichten von Ihren Nummern senden.

whatsapp_clientintegerDie meisten Messaging-Endpoints

Die ID der WhatsApp-Nummer, von der gesendet wird, angezeigt in der Spalte WhatsApp-Client-ID der WhatsApp-Einstellungen. Auf der Seite jedes Endpoints steht, ob er sie benötigt.

Der API-Schlüssel bestimmt, auf welchen Arbeitsbereich sich ein Request bezieht. Wenn Sie mehreren Arbeitsbereichen angehören, verwenden Sie einen Schlüssel, der in dem Arbeitsbereich erstellt wurde, aus dem Sie senden möchten.

Wenn ein Schlüssel in falsche Hände gerät, löschen Sie ihn auf der Seite „API-Schlüssel“. Gelöschte Schlüssel funktionieren sofort nicht mehr.

Ihr erster Request#

Dieser Request sendet eine Textnachricht von Ihrer verbundenen Nummer. Ersetzen Sie IDs, Schlüssel und Telefonnummer durch Ihre eigenen Werte.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Eine Antwort mit "status": 1 und einer msg_id bedeutet, dass die Nachricht in der Warteschlange ist. Nachricht senden erklärt jeden Parameter und enthält Versionen für Python, Node.js und PHP.

Antworten und Fehler#

Jede Antwort ist ein JSON-Objekt mit einem Feld status (außer beim Health-Check /api/v1/status/, der "status": 200 zurückgibt):

  • "status": 1 bedeutet, dass der Request erfolgreich war.
  • "status": 0 bedeutet, dass er fehlgeschlagen ist. Das Feld message nennt den Grund.
{ "status": 0, "message": "Auth Error: invalid api key" }

Häufige Authentifizierungsfehler:

MeldungBedeutung
Auth Errorclient_id oder api_key fehlt, der Body ist weder gültiges JSON noch gültige Formulardaten, oder der Request war kein POST.
Auth Error - Please send correct API key and Client idapi_key fehlt oder ist leer.
Invalid client id. oder Invalid Client Idclient_id ist keine ganze Zahl (oder fehlt, bei manchen Endpoints). Senden Sie den Wert als Zahl, zum Beispiel 12345.
Auth Error: invalid api keyDer Schlüssel existiert nicht, wurde gelöscht oder gehört nicht zu dieser client_id.
Demo Account can not access apisDemo-Konten können die API nicht nutzen.
Not enough creditsIhr Plan hat keine Nachrichten mehr übrig. Führen Sie ein Upgrade durch oder warten Sie auf Ihren nächsten Abrechnungszeitraum.

Lebenszyklus einer Nachricht#

Nachrichten, die Sie über die API senden, werden zuerst in eine Warteschlange gestellt und dann von Ihrer WhatsApp-Nummer gesendet. Jede Nachricht hat einen dieser Status:

StatusNameBedeutung
0CreatedIn der Warteschlange, wartet auf den Versand.
1SentVon Ihrer WhatsApp-Nummer gesendet.
2FailedKonnte nicht gesendet werden, zum Beispiel weil die Nummer nicht bei WhatsApp ist.
3CancelledVor dem Versand storniert.
4ExpiredNicht vor Ablauf der Frist expire_after_seconds gesendet.

Ihre WhatsApp-Nummer muss verbunden bleiben, damit Nachrichten aus der Warteschlange versendet werden. Ist die Nummer, über die Sie senden, getrennt, warten ihre Nachrichten in der Warteschlange, bis sie wieder verbunden ist oder die Nachrichten ablaufen. Nicht gesendete Nachrichten einer getrennten Nummer werden nach 90 Tagen entfernt.

Um eine Nachricht zu verfolgen, speichern Sie die msg_id aus der Antwort und übergeben Sie beim Senden entweder eine webhook-URL oder rufen Sie Nachrichtenstatus auf.

Offizielle Client-Bibliotheken#

Wrapper für Python und Node.js übernehmen die Authentifizierung und Datei-Uploads für Sie. Sie decken noch nicht jeden Endpoint korrekt ab. Prüfen Sie daher die Seite des jeweiligen Endpoints, bevor Sie sich auf eine Client-Methode verlassen.

pip install wbiztool-client

Lieber ohne Code? Unter Apps & Integrationen finden Sie Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify und WordPress.

Die Dokumentation durchsuchen#