Preskočiť na obsah

Rozhovory a správy

Metódy API na načítanie metadát konverzácií ChatHub, správu stavov a kontrolu historických reťazcov správ.

URL: https://chatapi.smsbat.com


1. Získajte všetky rozhovory

Získajte zoznam rozhovorov s dynamickým filtrovaním a stránkovaním.

Žiadosť - Spôsob: GET - URL: /api/chat/chats - Autorizácia: „Token na doručiteľa“ (povinné)

Parametre dopytu

Parameter Typ Popis
stránka "celé číslo" Číslo strany. Predvolená hodnota: 1
na_stranu "celé číslo" Položky na stránku. Predvolená hodnota: "20"
"hľadať" "reťazec" Textové vyhľadávanie (napr. meno, telefón)
"zdroj" "celé číslo" Zdrojový zoznam chatu (napr. 1 pre Viber Bot, 2 pre Telegram)
"dátum" "dátum a čas" Načítava rozhovory medzi dvoma dátumami (vyžaduje dva identické kľúče parametrov vo webovej adrese). Príklad: ?date=2026-01-28&date=2026-01-29
tg_user_id "celé číslo" ID používateľa telegramu
"telefón" "reťazec" Telefónne číslo
"stav" "celé číslo" 0 = Nové, 1 = Otvorené, 2 = Čaká sa, 3 = OnPause, 4 = Zatvorené
organizationId "celé číslo" Zúžiť podľa organizácie
operatorId "celé číslo" Zúžiť podľa priradeného operátora

Odpoveď (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. Zmeňte stav chatu

Aktualizuje priradený stav konkrétnej chatovej relácie.

Žiadosť - Spôsob: PUT - URL: /api/chat/status - Autorizácia: „Token na doručiteľa“. – Hlavičky: „Typ obsahu: application/json“.

Telo:

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

Hodnoty stavu Enum: - 0: Nové (novo vygenerované) - 1: Otvorené (aktívne spracované operátorom) - 2: Čaká sa (čaká sa na odpoveď používateľa) - 3: OnPause (stav pozastavenia) - „4“: Zatvorené (archivované)


3. Vymažte rozhovor

Natrvalo odstráni chat prostredníctvom jeho jedinečného ID.

Žiadosť - Spôsob: VYMAZAŤ - URL: /api/chat/chats/{id} - Autorizácia: „Token na doručiteľa“.

Odpoveď (200 OK) Vráti HTTP „200“ na potvrdenie úspešného odstránenia. Telo je zvyčajne prázdne alebo striktne „OK“`.


4. Načítajte chatové správy

Vypíše všetky správy historicky odoslané a prijaté v rámci konkrétneho rozhovoru.

Žiadosť - Spôsob: GET - URL: /api/chat/chats/{chatId}/messages - Autorizácia: „Token na doručiteľa“.

Odpoveď (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
  }
]
Autori: - "0": operátor - 1: Klient - 2: Systémový robot - 3: Viber Business Account

Typy správ: - "0": text - "1": Fotografia - 2: Súbor


5. Aktualizujte stav správ

Označí správu (alebo viacero správ) v rámci aktívneho rozhovoru s novými stavmi doručenia.

Žiadosť - Spôsob: PUT - URL: /api/chat/messages/status - Autorizácia: „Token na doručiteľa“. – Hlavičky: „Typ obsahu: application/json“.

Telo:

{
  "status": 3,
  "messageIds": [1, 2, 3]
}
(Stav 3 označí ID odoslanej správy ako "Prečítané")