Chaty a zprávy

Metody API pro načítání metadat konverzací ChatHub, správu stavů a kontrolu historických řetězců zpráv.

URL: https://chatapi.smsbat.com

---

1. Získejte všechny chaty

Získejte seznam chatů s dynamickým filtrováním a stránkováním.

Žádost - Metoda: GET - URL: /api/chat/chats - Autorizace: Token nositele (vyžadováno)

Parametry dotazu

Parametr	Typ	Popis
stránka	"celé číslo"	Číslo stránky. Výchozí: 1
za_stránku	"celé číslo"	Položky na stránku. Výchozí: "20"
"hledat"	"řetězec"	Textové vyhledávání (např. jméno, telefon)
"zdroj"	"celé číslo"	Chat Source Enum (např. 1 pro Viber Bot, 2 pro Telegram)
"datum"	"datum a čas"	Načte chaty mezi dvěma daty (vyžaduje dva identické klíče parametrů v adrese URL). Př: ?date=2026-01-28&date=2026-01-29
tg_user_id	"celé číslo"	ID uživatele telegramu
"telefon"	"řetězec"	Telefonní číslo
"stav"	"celé číslo"	0 = Nový, 1 = Otevřeno, 2 = Čekání, 3 = Při pozastavení, 4 = Zavřeno
ID organizace	"celé číslo"	Zúžit podle organizace
operatorId	"celé číslo"	Zúžit podle přiřazeného operátora

Odpověď (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. Změňte stav chatu

Aktualizuje přiřazený stav konkrétní chatovací relace.

Žádost - Metoda: PUT - URL: /api/chat/status - Oprávnění: Token nositele - Headers: Content-Type: application/json

Tělo:

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

Hodnoty stavového výčtu: - 0: Nový (nově vygenerovaný) - 1: Otevřít (aktivní obsluhované operátorem) - 2: Čekání (čekání na odpověď uživatele) - 3: OnPause (stav pozastaveno) - 4: Uzavřeno (archivováno)

---

3. Smazat chat

Trvale smaže chat prostřednictvím jeho jedinečného ID.

Žádost - Metoda: DELETE - URL: /api/chat/chats/{id} - Oprávnění: Token nositele

Odpověď (200 OK) Vrátí HTTP 200 pro potvrzení úspěšného odstranění. Tělo je obvykle prázdné nebo striktně "OK".

---

4. Načtení chatových zpráv

Vypíše všechny zprávy historicky odeslané a přijaté v rámci konkrétního chatu.

Žádost - Metoda: GET - URL: /api/chat/chats/{chatId}/messages - Oprávnění: Token nositele

Odpověď (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
  }
]

Autoři: - 0: Operátor - "1": Klient - 2: Systémový robot - 3: Obchodní účet Viber

Typy zpráv: - "0": Text - "1": Fotografie - 2: Soubor

---

5. Aktualizujte stav zpráv

Označí zprávu (nebo více zpráv) v aktivním chatu s novými stavy doručení.

Žádost - Metoda: PUT - URL: /api/chat/messages/status - Oprávnění: Token nositele - Headers: Content-Type: application/json

Tělo:

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

(Stav 3 označí ID odeslané zprávy jako "Přečteno")