Chats und Nachrichten

API-Methoden zum Abrufen von ChatHub-Konversationsmetadaten, zum Verwalten von Status und zum Überprüfen historischer Nachrichtenketten.

URL: „https://chatapi.smsbat.com“.

---

1. Alle Chats abrufen

Rufen Sie eine Liste von Chats mit dynamischer Filterung und Paginierung ab.

Anfrage

• Methode: GET
• URL: /api/chat/chats
• Autorisierung: „Bearer Token“ (erforderlich)

Abfrageparameter

Parameter	Geben Sie	ein Beschreibung
Seite	Ganzzahl	Seitenzahl. Standard: 1
per_page	Ganzzahl	Artikel pro Seite. Standard: 20
suchen	Zeichenfolge	Textsuche (z. B. Name, Telefonnummer)
„Quelle“	Ganzzahl	Chat-Quellen-Enum (z. B. „1“ für Viber Bot, „2“ für Telegram)
„Datum“	datetime	Ruft Chats zwischen zwei Daten ab (erfordert zwei identische Parameterschlüssel in der URL). Beispiel: ?date=2026-01-28&date=2026-01-29
tg_user_id	Ganzzahl	Telegram-Benutzer-ID
„Telefon“	Zeichenfolge	Telefonnummer
Status	Ganzzahl	0 = Neu, 1 = Offen, 2 = Wartend, 3 = OnPause, 4 = Geschlossen
Organisations-ID	Ganzzahl	Nach Organisation eingrenzen
operatorId	Ganzzahl	Eingrenzen nach zugewiesenem Operator

Antwort (200 OK)

{
  "total": 124,
  "items": [
    {
       "id": 123,
       "theme": "Support Ticket #491",
       "operator": {
           "id": 21,
           "name": "Jane",
           "photo": "url_to_photo.png"
       },
       "chatStatus": 1,
       "countUnread": 3
    }
  ]
}

---

2. Chat-Status ändern

Aktualisiert den zugewiesenen Status einer bestimmten Chat-Sitzung.

Anfrage

• Methode: PUT
• URL: /api/chat/status
• Autorisierung: „Bearer Token“.
• Header: Content-Type: application/json

Text:

{
  "id": 123,
  "status": 1
}

Status-Enum-Werte:

• 0: Neu (Neu generiert)
• „1“: Offen (vom Bediener aktiv bearbeitet)
• „2“: Warten (Warten auf Benutzerantwort)
• „3“: OnPause (Pausierter Zustand)
• „4“: Geschlossen (Archiviert)

---

3. Einen Chat löschen

Löscht einen Chat dauerhaft über seine eindeutige ID.

Anfrage

• Methode: LÖSCHEN
• URL: /api/chat/chats/{id}
• Autorisierung: „Bearer Token“.

Antwort (200 OK) Gibt ein HTTP „200“ zurück, um den erfolgreichen Löschvorgang zu bestätigen. Der Körper ist normalerweise leer oder streng „OK“.

---

4. Chat-Nachrichten abrufen

Löscht alle Nachrichten, die in der Vergangenheit innerhalb eines bestimmten Chats gesendet und empfangen wurden.

Anfrage

• Methode: GET
• URL: /api/chat/chats/{chatId}/messages
• Autorisierung: „Bearer Token“.

Antwort (200 OK)

[
  {
        "id": 1,
        "chatId": 123,
        "message": "Hello, how can I help?",
        "phone": "380936670003",
        "author": 0,
        "status": 3,
        "date": "2025-04-01T09:46:24.687Z",
        "operator": {
          "id": 21,
          "name": "Jane"
        },
        "messageType": 0
  }
]

Autoren:

• 0: Betreiber
• „1“: Kunde
• „2“: System-Bot
• „3“: Viber-Geschäftskonto

Nachrichtentypen:

• 0: Text
• „1“: Foto
• „2“: Datei

---

5. Nachrichtenstatus aktualisieren

Markiert eine Nachricht (oder mehrere Nachrichten) in einem aktiven Chat mit neuen Zustellungsstatus.

Anfrage

• Methode: PUT
• URL: /api/chat/messages/status
• Autorisierung: „Bearer Token“.
• Header: Content-Type: application/json

Text:

{
  "status": 3,
  "messageIds": [1, 2, 3]
}

(Status „3“ markiert die gesendeten Nachrichten-IDs als „Gelesen“)