Chatit ja viestit

API-menetelmät ChatHub-keskustelujen metatietojen hakemiseen, tilojen hallintaan ja historiallisten viestiketjujen tarkistamiseen.

URL-osoite: https://chatapi.smsbat.com

1. Hanki kaikki keskustelut

Hae luettelo keskusteluista, joissa on dynaaminen suodatus ja sivutus.

Pyyntö - Menetelmä: HANKI - URL-osoite: /api/chat/chats - Valtuutus: "Bearer Token" (pakollinen)

Kyselyparametrit

Parametri	Tyyppi	Kuvaus
"sivu"	"kokonaisluku"	Sivunumero. Oletus: "1"
"sivua kohden"	"kokonaisluku"	Kohteita per sivu. Oletus: "20"
"haku"	"merkkijono"	Tekstihaku (esim. nimi, puhelin)
"lähde"	"kokonaisluku"	Chat Source Enum (esim. "1" Viber Botille, "2" Telegramille)
"päivämäärä"	"päivämäärä"	Hakee keskustelut kahden päivämäärän välillä (vaatii kaksi identtistä parametriavainta URL-osoitteessa). Esim: "?date=2026-01-28&date=2026-01-29"
`tg_user_id`	"kokonaisluku"	Telegram käyttäjätunnus
`puhelin`	"merkkijono"	Puhelinnumero
"tila"	"kokonaisluku"	`0` = Uusi, `1` = Avoin, `2` = Odottaa, `3` = Keskeytetty, `4` = Suljettu
`organisationId`	`kokonaisluku`	Rajaa organisaation mukaan
"operatorId"	`kokonaisluku`	Rajaa määritetyn operaattorin mukaan

Vastaus (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. Muuta keskustelutilaa

Päivittää tietyn chat-istunnon määritetyn tilan.

Pyyntö - Menetelmä: PUT - URL-osoite: /api/chat/status - Valtuutus: "Kantajatunnus". - Otsikot: "Sisältötyyppi: sovellus/json".

Runko:

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

Tilaluettelon arvot: - "0": Uusi (äskettäin luotu) - 1: Avoin (käyttäjä hoitaa aktiivisesti) - 2: Odotetaan (odotetaan käyttäjän vastausta) - 3: OnPause (keskeytetty tila) - 4: Suljettu (arkistoitu)

3. Poista keskustelu

Poistaa keskustelun pysyvästi sen yksilöllisen tunnuksen avulla.

Pyyntö - Menetelmä: POISTA - URL-osoite: /api/chat/chats/{id} - Valtuutus: "Kantajatunnus".

Vastaus (200 OK) Palauttaa HTTP `200' vahvistaakseen onnistuneen poiston. Runko on yleensä tyhjä tai ehdottomasti "OK".

4. Hae chat-viestit

Jättää kaikki tietyn chatin aikana lähetetyt ja vastaanotetut viestit.

Pyyntö - Menetelmä: HANKI - URL-osoite: /api/chat/chats/{chatId}/messages - Valtuutus: "Kantajatunnus".

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

Kirjoittajat: - 0: Operaattori - 1: Asiakas - 2: Järjestelmäbotti - 3: Viber-yritystili

Viestityypit: - 0: Teksti - 1: Valokuva - 2: Tiedosto

5. Päivitä viestien tila

Merkitsee viestin (tai useita viestejä) aktiivisessa chatissa uusilla toimitustiloilla.

Pyyntö - Menetelmä: PUT - URL-osoite: /api/chat/messages/status - Valtuutus: "Kantajatunnus". - Otsikot: "Sisältötyyppi: sovellus/json".

Runko:

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

(Tila 3 merkitsee lähetettyjen viestien tunnukset "Luettuiksi")