Pokalbiai ir žinutės

API metodai, skirti gauti „ChatHub“ pokalbių metaduomenis, tvarkyti būsenas ir peržiūrėti istorines pranešimų grandines.

URL: https://chatapi.smsbat.com

---

1. Gaukite visus pokalbius

Gaukite pokalbių sąrašą su dinaminiu filtravimu ir puslapiais.

Prašymas - Metodas: GAUTI - URL: /api/chat/chats – Įgaliojimas: „Turėjo prieigos raktas“ (būtinas)

Užklausos parametrai

Parametras	Tipas	Aprašymas
"puslapis"	"sveikasis skaičius"	Puslapio numeris. Numatytasis: „1“
„per_puslapį“	"sveikasis skaičius"	Prekės puslapyje. Numatytoji vertė: „20“
ieškoti	"styga"	Teksto paieška (pvz., vardas, telefonas)
"šaltinis"	"sveikasis skaičius"	Pokalbių šaltinio rinkinys (pvz., „1“ „Viber Bot“, „2“ – „Telegram“)
"data"	"data ir laikas"	Gauna pokalbius tarp dviejų datų (URL reikia dviejų identiškų parametrų raktų). Pvz.: "?date=2026-01-28&date=2026-01-29"
tg_user_id	"sveikasis skaičius"	Telegram vartotojo ID
telefonas	"styga"	Telefono numeris
"būsena"	"sveikasis skaičius"	0 = Nauja, 1 = Atidaryta, 2 = Laukiama, 3 = Pristabdyta, 4 = Uždaryta
organizationId	"sveikasis skaičius"	Susiaurinti pagal organizaciją
„operatoriaus ID“	"sveikasis skaičius"	Siaurinti pagal priskirtą operatorių

Atsakymas (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. Pakeiskite pokalbių būseną

Atnaujina konkretaus pokalbio seanso priskirtą būseną.

Prašymas - Metodas: PUT - URL: /api/chat/status - Įgaliojimas: „Turėtojo ženklas“. – Antraštės: „Turinio tipas: programa/json“.

Kūnas:

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

Būsenos sąrašo reikšmės: - „0“: nauja (naujai sukurta) - „1“: atidarytas (aktyviai tvarko operatorius) - 2: Laukiama (laukiama vartotojo atsakymo) - „3“: „OnPause“ (pristabdyta būsena) - „4“: uždaryta (archyvuota)

---

3. Ištrinkite pokalbį

Visam laikui ištrina pokalbį naudodamas unikalų ID.

Prašymas - Metodas: IŠTRINTI - URL: /api/chat/chats/{id} - Įgaliojimas: „Turėtojo ženklas“.

Atsakymas (200 OK) Grąžina HTTP „200“, kad patvirtintų sėkmingą ištrynimą. Turinys paprastai yra tuščias arba griežtai „Gerai“.

---

4. Gaukite pokalbių pranešimus

Išmeta visus istoriškai išsiųstus ir gautus pranešimus tam tikrame pokalbyje.

Prašymas - Metodas: GAUTI - URL: /api/chat/chats/{chatId}/messages - Įgaliojimas: „Turėtojo ženklas“.

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

Autoriai: - „0“: operatorius - "1": klientas - „2“: sistemos robotas - „3“: „Viber Business“ paskyra

Pranešimų tipai: - „0“: tekstas - 1: Nuotrauka - „2“: failas

---

5. Atnaujinkite pranešimų būseną

Pažymi pranešimą (arba kelis pranešimus) aktyviame pokalbyje su naujomis pristatymo būsenomis.

Prašymas - Metodas: PUT – URL: „/api/chat/messages/status“. - Įgaliojimas: „Turėtojo ženklas“. – Antraštės: „Turinio tipas: programa/json“.

Kūnas:

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

(Būsena „3“ pažymi išsiųstų pranešimų ID kaip „Skaityti“)