Skip to Content
Wazend

Chats

Verwalte WhatsApp-Chats mit Wazend: auflisten, archivieren, löschen, als gelesen markieren, Nachrichten anheften und mehr.

Methoden zum Verwalten von WhatsApp-Chats und -Nachrichten.

  • {session} — Name deiner Sitzung (steht im Dashboard, zum Beispiel S0001).
  • {chatId} — ID des Chats im Format 123123123123@c.us (direkt) oder 123123123123@g.us (Gruppe).

Alle Chats abrufen

GET /api/{session}/chats

Abfrageparameter:

GET /api/{session}/chats?limit=100&offset=0&sortBy=messageTimestamp&sortOrder=desc
  • limit=100 — begrenzt die Anzahl der zurückgegebenen Chats.
  • offset=0 — überspringt N Chats ab dem Anfang.
  • sortBy — sortiert nach Feld: messageTimestamp (letzte Nachricht), id oder name.
  • sortOrder — desc (neueste zuerst) oder asc(älteste zuerst).

Tipp

Wenn timeout angezeigt wird oder die Anfrage zu lange dauert, verwende limit, um die Objekte in kleineren Teilen abzurufen.

Chat-Übersicht abrufen

Die API, die fast jeder Chat-Oberflächen-Client benötigt.

GET /api/{session}/chats/overview?limit=20&offset=0
  • limit / offset — Paginierung.
  • ids=11111&ids=9999@c.us — filtert nach ID oder Telefonnummer.

Verwende POST wenn du viele Chats (>400) im Filter hast ids:

POST /api/{session}/chats/overview
Body
{
  "pagination": { "limit": 20, "offset": 0 },
  "filter": { "ids": ["5215551234567@c.us"] }
}
Antwort
[
  {
    "id": "5215551234567@c.us",
    "name": "Juan Pérez",
    "picture": "https://ejemplo.com/foto.jpg",
    "lastMessage": {
      "id": "true_5215551234567@c.us_AAAA",
      "timestamp": 1667561485,
      "from": "5215551234567@c.us",
      "fromMe": true,
      "body": "Hallo"
    }
  }
]

Chat-Bild abrufen

GET /api/{session}/chats/{chatId}/picture?refresh=true
Antwort
{ "url": "https://ejemplo.com/foto.jpg" }

url kann null sein, wenn der Chat kein Bild hat. refresh=true erzwingt die Aktualisierung (24 h gecacht).

Chat archivieren / dearchivieren

POST /api/{session}/chats/{chatId}/archive
POST /api/{session}/chats/{chatId}/unarchive

Chat als ungelesen markieren

POST /api/{session}/chats/{chatId}/unread

Chat löschen

DELETE /api/{session}/chats/{chatId}

Nachrichten als gelesen markieren

Markiert alle ungelesenen Nachrichten des Chats als gelesen (blauer Doppelhaken).

POST /api/{session}/chats/{chatId}/messages/read
Body
{ "messages": 30, "days": 7 }
Body
{
  "ids": [
    "false_5215551234567@c.us_AAAA",
    "true_5215551234567@c.us_BBBB"
  ]
}
  • messages — wie viele Nachrichten gelesen werden (Standard 30 in direkten Chats, 100 in Gruppen).
  • days — wie viele Tage gelesen werden (Standard 7).

Nachrichten abrufen

GET /api/{session}/chats/{chatId}/messages?limit=10

Verfügbare Parameter:

  • downloadMedia=true — Multimediadateien herunterladen.
  • limit / offset Paginierung.
  • filter.timestamp.gte / filter.timestamp.lte — nach Zeitstempel filtern.
  • filter.fromMe=false — eigene Nachrichten ausschließen.
  • filter.ack — nach Bestätigungsstatus filtern: ERROR (-1), PENDING (0), SERVER (1), DEVICE (2), READ (3), PLAYED (4).
Antwort
[
  {
    "id": "false_5215551234567@c.us_AAAAAA",
    "timestamp": 1727745026,
    "from": "5215551234567@c.us",
    "fromMe": false,
    "body": "Hallo!",
    "hasMedia": false,
    "ack": 3,
    "ackName": "READ",
    "replyTo": null
  }
]

Nachricht per id abrufen

GET /api/{session}/chats/{chatId}/messages/{messageId}?downloadMedia=true

Nachricht anheften / lösen

POST /api/{session}/chats/{chatId}/messages/{messageId}/pin
Body
{
  "duration": 86400
}

Dauer: 24 Stunden = 86400, 7 Tage = 604800, 30 Tage = 2592000.

POST /api/{session}/chats/{chatId}/messages/{messageId}/unpin

Nachricht bearbeiten

PUT /api/{session}/chats/{chatId}/messages/{messageId}
Body
{ "text": "Bearbeitete Nachricht" }

Information

Denke daran, @ mit %40 in chatId und messageId zu escapen.

Nachricht löschen

DELETE /api/{session}/chats/{chatId}/messages/{messageId}

Alle Nachrichten löschen

DELETE /api/{session}/chats/{chatId}/messages

Ereignisse

Empfange Chat-Ereignisse über Ereignisse. Das Ereignis chat.archive wird ausgelöst, wenn ein Chat archiviert oder dearchiviert wird (siehe Detailbeschreibung der Payload auf der Ereignis-Seite).