Klepeti in sporočila
Metode API-ja za pridobivanje metapodatkov pogovorov ChatHub, upravljanje statusov in pregled zgodovinskih verig sporočil.
URL: https://chatapi.smsbat.com
1. Pridobite vse klepete
Pridobite seznam klepetov z dinamičnim filtriranjem in označevanjem strani.
Zahteva
- Metoda: GET
- URL: /api/chat/chats
- Avtorizacija: Bearer Token (obvezno)
Parametri poizvedbe
| Parameter | Vrsta | Opis |
|---|---|---|
stran |
celo število |
Številka strani. Privzeto: 1 |
na_stran |
celo število |
Predmetov na stran. Privzeto: 20 |
iskanje |
niz |
Besedilno iskanje (npr. ime, telefon) |
vir |
celo število |
Chat Source Enum (npr. 1 za Viber Bot, 2 za Telegram) |
datum |
datum-ura |
Pridobi klepete med dvema datumoma (zahteva dva enaka ključa parametrov v URL-ju). Primer: ?datum=2026-01-28&datum=2026-01-29 |
tg_user_id |
celo število |
ID uporabnika Telegram |
telefon |
niz |
Telefonska številka |
stanje |
celo število |
0 = Novo, 1 = Odprto, 2 = Čakanje, 3 = V premoru, 4 = Zaprto |
ID organizacije |
celo število |
Ožji po organizaciji |
operatorId |
celo število |
Zoži glede na dodeljeni operater |
Odgovor (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. Spremenite status klepeta
Posodobi dodeljeni status določene seje klepeta.
Zahteva
- Metoda: PUT
- URL: /api/chat/status
- Avtorizacija: Bearer Token
- Glave: Content-Type: application/json
Telo:
Vrednosti Enum stanja:
- 0: Novo (na novo ustvarjeno)
- 1: Odprto (aktivno upravlja operater)
- 2: Čakanje (čakam na odgovor uporabnika)
- 3: OnPause (stanje začasne zaustavitve)
- 4: Zaprto (Arhivirano)
3. Izbriši klepet
Trajno izbriše klepet prek njegovega edinstvenega ID-ja.
Zahteva
- Metoda: DELETE
- URL: /api/chat/chats/{id}
- Avtorizacija: Bearer Token
Odgovor (200 OK)
Vrne HTTP 200 za potrditev uspešnega izbrisa. Telo je običajno prazno ali strogo "OK".
4. Pridobite sporočila klepeta
Izpiše vsa sporočila, poslana in prejeta znotraj določenega klepeta.
Zahteva
- Metoda: GET
- URL: /api/chat/chats/{chatId}/messages
- Avtorizacija: Bearer Token
Odgovor (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
}
]
0: operater
- 1: odjemalec
- 2: sistemski bot
- 3: poslovni račun Viber
Vrste sporočil:
- 0: Besedilo
- 1: Fotografija
- 2: Datoteka
5. Posodobite status sporočil
Označi sporočilo (ali več sporočil) znotraj aktivnega klepeta z novimi statusi dostave.
Zahteva
- Metoda: PUT
- URL: /api/chat/messages/status
- Avtorizacija: Bearer Token
- Glave: Content-Type: application/json
Telo:
(Status3 označuje ID-je poslanih sporočil kot "Prebrano")