Vestlused ja sõnumid

API meetodid ChatHubi vestluste metaandmete toomiseks, olekute haldamiseks ja ajalooliste sõnumiahelate ülevaatamiseks.

URL: https://chatapi.smsbat.com

1. Hankige kõik vestlused

Hankige dünaamilise filtreerimise ja lehekülgede jagamisega vestluste loend.

Taotlus - Meetod: HANGI - URL: /api/chat/chats - Authorisatsioon: "Esitaja tunnus" (nõutav)

Päringu parameetrid

Parameeter	Tüüp	Kirjeldus
leht	"täisarv"	Lehekülje number. Vaikimisi: "1"
„lehe kohta”	"täisarv"	Üksusi lehel. Vaikimisi: "20"
`otsing`	"string"	Tekstiotsing (nt nimi, telefon)
"allikas"	"täisarv"	Vestluse allika loend (nt "1" Viber Boti jaoks, "2" Telegrami jaoks)
"kuupäev"	"kuupäev ja kellaaeg"	Toob vestlused kahe kuupäeva vahel (nõuab URL-is kahte identset parameetrivõtit). Nt: "?date=2026-01-28&date=2026-01-29"
`tg_user_id`	"täisarv"	Telegrami kasutaja ID
`telefon`	"string"	Telefoninumber
`olek`	"täisarv"	`0` = uus, `1` = avatud, `2` = ootel, `3` = peatatud, `4` = suletud
`organisatsiooniId`	`täisarv`	Organisatsiooni järgi kitsas
operaatori ID	`täisarv`	Kitsenda määratud operaatori järgi

Vastus (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. Muutke vestluse olekut

Värskendab konkreetse vestlusseansi määratud olekut.

Taotlus - Meetod: PANE - URL: /api/chat/status - ** Volitus: kandja märk - Päised:** "Sisutüüp: rakendus/json".

Keha:

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

Olekenumi väärtused: - "0": uus (vastloodud) - "1": avatud (operaator tegeleb aktiivselt) - 2: Ootel (ootab kasutaja vastust) - 3: OnPause (peatatud olek) - 4: suletud (arhiveeritud)

3. Kustutage vestlus

Kustutab vestluse jäädavalt selle kordumatu ID kaudu.

Taotlus - Meetod: KUSTUTA - URL: /api/chat/chats/{id} - ** Volitus:** kandja märk

Vastus (200 OK) Tagastab eduka kustutamise kinnitamiseks HTTP „200”. Keha on tavaliselt tühi või rangelt "OK".

4. Vestlussõnumite toomine

Loobub kõik konkreetses vestluses varem saadetud ja vastu võetud sõnumid.

Taotlus - Meetod: HANGI - URL: /api/chat/chats/{chatId}/messages' - ** Volitus:**kandja märk`

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

Autorid: - "0": operaator - "1": klient - "2": süsteemibot - "3": Viberi ärikonto

Sõnumi tüübid: - "0": tekst - 1: foto - "2": fail

5. Värskendage sõnumite olekut

Märgib aktiivses vestluses oleva sõnumi (või mitu sõnumit) uute edastamisolekutega.

Taotlus - Meetod: PANE - URL: /api/chat/messages/status - ** Volitus: kandja märk - Päised:** "Sisutüüp: rakendus/json".

Keha:

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

(Olek "3" tähistab saadetud sõnumite ID-d kui "loetud")