Zum Inhalt springen
WbizTool

API v2 (Beta)

Nummern

Eine Nummer ist eine WhatsApp-Nummer oder ein Telegram-Konto, das mit Ihrem Arbeitsbereich verbunden ist. Ihre id ist das from, mit dem Sie Nachrichten senden. Mit der API v2 listen Sie sie auf, sehen, ob jede verbunden ist, und verbinden eine WhatsApp-Nummer aus Ihrer eigenen App, per QR-Code oder Kopplungscode.

VorgangEndpointScope
Nummern auflistenGET /api/v2/numbersnumbers
Eine Nummer abrufenGET /api/v2/numbers/{id}numbers
WhatsApp-Nummer verbindenPOST /api/v2/numbersnumbers

Ein auf einige Nummern beschränkter Schlüssel sieht und verbindet nur diese neu und kann keine Nummer hinzufügen.

Nummern auflisten#

GEThttps://wbiztool.com/api/v2/numbers

Alle Nummern des Arbeitsbereichs, die älteste zuerst, in einer einzigen data-Liste (ohne Seiten).

curl https://wbiztool.com/api/v2/numbers \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    {
      "id": 101,
      "phone": "919800000000",
      "label": "Shop",
      "platform": "whatsapp",
      "status": "connected",
      "login_method": "qr",
      "connect": null
    },
    {
      "id": 102,
      "phone": null,
      "label": "",
      "platform": "whatsapp",
      "status": "disconnected",
      "login_method": "qr",
      "connect": null
    }
  ]
}

connect ist in der Liste immer null. Um eine Verbindung zu verfolgen, rufen Sie die Nummer ab.

Eine Nummer abrufen#

GEThttps://wbiztool.com/api/v2/numbers/{id}

Eine einzelne Nummer. Während sie verbunden wird, enthält connect den QR-Code zum Scannen oder den Kopplungscode zum Eingeben.

curl https://wbiztool.com/api/v2/numbers/102 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "id": 102,
  "phone": null,
  "label": "",
  "platform": "whatsapp",
  "status": "connecting",
  "login_method": "qr",
  "connect": {
    "qr_code_url": "https://…/qr_codes/…png?X-Amz-Signature=…",
    "pairing_code": null,
    "pairing_code_expires_at": null,
    "linking": false,
    "requested_at": "2026-10-18T11:02:15.402Z"
  }
}

Eine Nummer, die nicht existiert oder die der Schlüssel nicht nutzen darf, antwortet mit 404 number_not_found.

Das Number-Objekt#

FeldTypBeschreibung
idintegerDie ID der Nummer: das from einer Nachricht oder Erinnerung.
phonestring or nullIhre Ziffern mit Ländervorwahl, ohne +, zum Beispiel 919800000000. null bei einer neuen, per QR verbundenen Nummer, bis der QR-Code gescannt ist.
labelstringIhr Name im Dashboard; "", wenn sie keinen hat.
platformstringwhatsapp oder telegram.
statusstringconnected, connecting (eine Verbindung wurde in den letzten 10 Minuten angefordert und läuft noch) oder disconnected.
login_methodstringWie sie sich verbindet: qr oder phone_code (ein Kopplungscode).
connectobject or nullSolange status connecting ist, und nur bei Eine Nummer abrufen; sonst null.

connect enthält:

FeldTypBeschreibung
qr_code_urlstring or nullEin Link zum QR-Code-Bild, das gescannt wird. Jeder Aufruf liefert einen neuen Link, 10 Minuten gültig; null, bis der Server den QR-Code hat.
pairing_codestring or nullBei phone_code: der Code, der auf dem Smartphone eingegeben wird. null, bis er bereit ist.
pairing_code_expires_atstring or nullWann der Kopplungscode nicht mehr funktioniert.
linkingbooleantrue, sobald der QR-Code gescannt oder der Code angenommen wurde, während WhatsApp die Verknüpfung abschließt.
requested_atstring or nullWann die Verbindung angefordert wurde.

Nachrichten mit einer Nummer im Status disconnected als from werden trotzdem angenommen: Sie warten und gehen raus, sobald die Nummer wieder verbunden ist. Webhook-Ereignisse für Nummern folgen später; bis dahin fragen Sie GET /numbers regelmäßig ab, um eine abgemeldete Nummer zu bemerken.

WhatsApp-Nummer verbinden#

POSThttps://wbiztool.com/api/v2/numbers

Body: JSON (application/json)

Bittet einen WbizTool-Server, WhatsApp für eine Nummer zu öffnen, damit Sie sie aus Ihrer eigenen App oder Website verknüpfen können, so wie unter WhatsApp-Nummern. Die Antwort ist 202 mit der Nummer im Status connecting. Fragen Sie sie dann regelmäßig ab, bis sie connected ist.

Dafür ist ein Plan nötig, der die QR-Code-API enthält; sonst lautet die Antwort 403 plan_required. Telegram-Konten werden im Dashboard verbunden, nicht hier.

Body

login_methodstringoptional

qr (Standard): einen QR-Code scannen. phone_code: stattdessen einen Kopplungscode auf dem Smartphone eingeben, praktisch, wenn das Smartphone der einzige Bildschirm ist.

phonestringErforderlich für phone_code

Die WhatsApp-Nummer, die verknüpft wird, im internationalen Format mit +, zum Beispiel +919876543210. Bei qr nicht verwendet: Die Nummer wird nach dem Scan aus WhatsApp gelesen.

number_idintegeroptional

Diese bestehende Nummer neu verbinden, statt eine neue hinzuzufügen, zum Beispiel nachdem sie abgemeldet wurde.

# By QR code
curl -X POST https://wbiztool.com/api/v2/numbers \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"login_method": "qr"}'

# By pairing code, reconnecting number 101
curl -X POST https://wbiztool.com/api/v2/numbers \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"login_method": "phone_code", "phone": "+919876543210", "number_id": 101}'

Der Verbindungsablauf#

  1. Verbindung anfordern

    POST /numbers mit login_method (und phone für einen Kopplungscode). Merken Sie sich die id aus der Antwort. Senden Sie einen Idempotency-Key, damit ein erneuter Versuch nicht doppelt anfordert.

  2. Die Nummer alle paar Sekunden abfragen

    GET /numbers/{id} alle 2 bis 5 Sekunden, solange status connecting ist. Der QR-Code oder Kopplungscode erscheint innerhalb kurzer Zeit in connect; bis dahin sind seine Felder null.

  3. QR-Code oder Kopplungscode anzeigen

    QR: Zeigen Sie das Bild unter connect.qr_code_url an; öffnen Sie auf dem Smartphone WhatsApp → Verknüpfte Geräte → Gerät hinzufügen und scannen Sie es. Jeder Link funktioniert 10 Minuten, und mit jeder Abfrage kommt ein neuer, zeigen Sie also jedes Mal den neuesten an. Kopplungscode: Öffnen Sie auf dem Smartphone WhatsApp → Verknüpfte Geräte → Gerät hinzufügen → Stattdessen mit Telefonnummer verknüpfen und geben Sie den 8-stelligen connect.pairing_code vor connect.pairing_code_expires_at ein (etwa 3 Minuten).

  4. Auf connected warten

    Nach dem Scan oder dem Code ist connect.linking true, während WhatsApp die Verknüpfung abschließt. Dann wird status zu connected, und phone zeigt die Nummer. Beenden Sie die Abfragen.

Passiert 10 Minuten lang nichts, endet der Versuch, und status wechselt zurück zu disconnected. Fordern Sie erneut mit POST /numbers und ihrer number_id an.

Während eine Nummer verbunden wird, antwortet ein weiterer Request für sie mit 409 connect_in_progress und ihrer number_id: Fragen Sie stattdessen weiter diese ab.

Fehler beim Verbinden#

HTTPCodeWann
400validation_failedlogin_method ist weder qr noch phone_code, oder phone_code ohne phone
403plan_requiredDer Plan enthält die QR-Code-API nicht
403number_limit_reachedIm Plan ist kein Platz für eine weitere Nummer
403number_not_allowedDer Schlüssel ist auf einige Nummern beschränkt, und number_id gehört nicht dazu (oder fehlt)
409already_connectedDiese Nummer ist bereits verbunden
409connect_in_progressDiese Nummer wird gerade verbunden; number_id nennt sie
422invalid_phonephone ist keine gültige Nummer im internationalen Format mit +
422number_not_foundnumber_id ist keine Nummer dieses Arbeitsbereichs

Verwandte Themen#