Chats en berichten

API-methoden voor het ophalen van metadata van ChatHub-gesprekken, het beheren van statussen en het bekijken van historische berichtenketens.

URL: https://chatapi.smsbat.com

---

1. Ontvang alle chats

Haal een lijst met chats op met dynamische filtering en paginering.

Verzoek

• Methode: KRIJG
• URL: /api/chat/chats
• Autorisatie: Bearer Token (vereist)

Queryparameters

Parameter	Typ	Beschrijving
pagina	geheel getal	Paginanummer. Standaard: 1
per_pagina	geheel getal	Artikelen per pagina. Standaard: 20
zoeken	tekenreeks	Tekst zoeken (bijvoorbeeld naam, telefoon)
bron	geheel getal	Chatbron Enum (bijvoorbeeld 1 voor Viber Bot, 2 voor Telegram)
datum	datumtijd	Haalt chats op tussen twee datums (vereist twee identieke parametersleutels in de URL). Bijv.: ?date=2026-01-28&date=2026-01-29
tg_user_id	geheel getal	Telegram-gebruikers-ID
telefoon	tekenreeks	Telefoonnummer
status	geheel getal	0 = Nieuw, 1 = Open, 2 = Wachten, 3 = AanPauze, 4 = Gesloten
organisatie-ID	geheel getal	Beperken op organisatie
operatorId	geheel getal	Beperken op toegewezen operator

Reactie (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. Wijzig de chatstatus

Werkt de toegewezen status van een specifieke chatsessie bij.

Verzoek

• Methode: ZET
• URL: /api/chat/status
• Autorisatie: Bearer Token
• Headers: Contenttype: application/json

Lichaam:

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

Status Enum-waarden:

• 0: Nieuw (nieuw gegenereerd)
• 1: Open (actief afgehandeld door operator)
• 2: Wachten (wacht op antwoord van gebruiker)
• 3: OnPause (pauzestatus)
• 4: Gesloten (gearchiveerd)

---

3. Verwijder een chat

Verwijdert een chat permanent via zijn unieke ID.

Verzoek

• Methode: VERWIJDEREN
• URL: /api/chat/chats/{id}
• Autorisatie: Bearer Token

Reactie (200 OK) Retourneert een HTTP 200 om succesvolle verwijdering te bevestigen. Het lichaam is doorgaans leeg of strikt ‘OK’.

---

4. Chatberichten ophalen

Dumpt alle berichten die historisch zijn verzonden en ontvangen binnen een bepaalde chat.

Verzoek

• Methode: KRIJG
• URL: /api/chat/chats/{chatId}/messages
• Autorisatie: Bearer Token

Reactie (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
  }
]

Auteurs:

• 0: Operator
• 1: Klant
• 2: Systeembot
• 3: Viber Business-account

Berichttypen:

• 0: Tekst
• 1: Foto
• 2: Bestand

---

5. Update berichtenstatus

Markeert een bericht (of meerdere berichten) in een actieve chat met nieuwe bezorgstatussen.

Verzoek

• Methode: ZET
• URL: /api/chat/berichten/status
• Autorisatie: Bearer Token
• Headers: Contenttype: application/json

Lichaam:

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

(Status 3 markeert de verzonden bericht-ID’s als “Gelezen”)