Skip to Content
Wazend

Sitzungen

Steuere WhatsApp-Sitzungen in Wazend: Lebenszyklus, Status, QR, Pairing-Code und mehr.

Eine Sitzung repräsentiert ein WhatsApp-Konto (Telefonnummer), das mit Wazend verbunden ist und das du zum Senden und Empfangen von Nachrichten verwenden kannst.

Lebenszyklus

Bevor du Nachrichten senden oder empfangen kannst, musst du eine Sitzung starten und sie per QR-Code oder Pairing-Code authentifizieren.

Status der Sitzung

  • STOPPED — die Sitzung ist gestoppt.
  • STARTING — die Sitzung startet.
  • SCAN_QR_CODE — Es ist erforderlich, den QR zu scannen oder sich per Telefonnummer anzumelden. Jedes Mal, wenn dieser Status ausgegeben wird, ändert sich der QR und du musst den aktualisierten QR abrufen.
  • PASSKEY_REQUIRED — WhatsApp fordert einen Passkey (WebAuthn) an, um das Pairing abzuschließen.
  • PASSKEY_CONFIRMATION_REQUIRED — der Nutzer muss einen Code verifizieren, bevor er das Pairing abschließt.
  • WORKING — die Sitzung funktioniert und ist einsatzbereit.
  • FAILED — die Sitzung ist aufgrund eines Fehlers fehlgeschlagen. Dies bedeutet normalerweise, dass eine erneute Autorisierung erforderlich ist oder dass das Gerät vom Konto getrennt wurde.

Sitzung im Status FAILED

Versuche im Status FAILED, die Sitzung neu zu starten. Wenn es nicht funktioniert, melde dich ab und starte sie erneut.

Sitzung aktualisieren

Aktualisiere eine Sitzung mit einer vollständigen neuen Konfiguration.

PUT /api/sessions/{session}
Body
{
  "config": {
    "webhooks": [
      {
        "url": "https://tu-servidor.com/webhook",
        "events": ["message"]
      }
    ]
  }
}

Die Sitzung wird neu gestartet

Wenn die Sitzung nicht im Status STOPPED ist, wird sie gestoppt und mit der neuen Konfiguration gestartet.

Sitzung starten

POST /api/sessions/{session}/start

Information

Idempotente Operation: Du kannst sie mehrmals aufrufen; sie startet nur, wenn sie nicht läuft.

Sitzung stoppen

POST /api/sessions/{session}/stop

Information

Stoppen meldet die Sitzung nicht ab und löscht nichts. Idempotente Operation.

Sitzung neu starten

POST /api/sessions/{session}/restart

Warnung

Wenn die Sitzung bereits läuft (nicht im Status STOPPED), wird sie gestoppt und neu gestartet.

Abmelden (Logout)

POST /api/sessions/{session}/logout

Warnung

Das Abmelden entfernt die Authentifizierungsinformationen und Daten, behält aber die Konfiguration. Wenn die Sitzung im Status WORKING ist, entfernt es außerdem das Gerät aus der Liste der Verknüpften Geräte.

Sitzungen auflisten

GET /api/sessions

Sitzung abrufen

GET /api/sessions/{session}

QR abrufen

Rufe den QR-Code ab, um die Sitzung durch Scannen mit der WhatsApp-App zu authentifizieren.

GET /api/{session}/auth/qr?format=raw

Verwende format=raw, um die Code-Zeichenkette zu erhalten, oder format=image für das PNG.

Pairing-Code

Rufe einen numerischen Code ab, um die Sitzung über die WhatsApp-App zu verknüpfen.

POST /api/{session}/auth/request-code

Profilinformationen abrufen (Me)

GET /api/sessions/{session}/me
Antwort
{
  "id": "5215551234567@c.us",
  "pushName": "Mi Nombre",
  "reachoutTimelock": null,
  "messageCapping": null
}

Passkey

Bei einigen Pairings fordert WhatsApp einen Passkey (WebAuthn) an. Die Status PASSKEY_REQUIRED und PASSKEY_CONFIRMATION_REQUIRED zeigen an, dass der Nutzer diesen Schritt abschließen muss, um das Pairing zu beenden.

Ereignisse

Die Sitzung gibt Ereignisse aus, die du über Ereignisse oder WebSockets empfangen kannst. Das wichtigste Ereignis ist session.status; siehe die Detailbeschreibung der Payload auf der Ereignis-Seite.