Chat-uri și Mesaje
Metode API pentru preluarea metadatelor conversațiilor ChatHub, gestionarea stărilor și revizuirea lanțurilor de mesaje istorice.
URL: https://chatapi.smsbat.com
1. Obțineți toate chaturile
Preluați o listă de chat-uri cu filtrare dinamică și paginare.
Solicitare
- Metoda: GET
- URL:
/api/chat/chats - Autorizare:
Bearer Token(obligatoriu)
Parametrii de interogare
| Parametru | Tip | Descriere |
|---|---|---|
pagina | ntreg | Numărul paginii. Implicit: 1 |
pe_pagin | ntreg | Articole pe pagină. Implicit: 20 |
căutare | șir | Căutare text (de exemplu, nume, telefon) |
sursa | ntreg | Chat Source Enum (de exemplu, 1 pentru Viber Bot, 2 pentru Telegram) |
data | datetime | Preia conversațiile prin chat între două date (necesită două chei de parametri identice în adresa URL). Ex: ?date=2026-01-28&date=2026-01-29 |
tg_user_id | ntreg | ID utilizator Telegram |
telefon | șir | Număr de telefon |
starea | ntreg | 0 = Nou, 1 = Deschis, 2 = În așteptare, 3 = OnPause, 4 = Închis |
organizationId | ntreg | Restrângeți după organizație |
operatorId | ntreg | Restrângeți după operatorul alocat |
Răspuns (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. Schimbați starea chatului
Actualizează starea atribuită unei anumite sesiuni de chat.
Solicitare
- Metoda: PUN
- URL:
/api/chat/status - Autorizare:
Jeton de purtător - Headers:
Content-Type: application/json
Corpul:
{
"id": 123,
"status": 1
}
Valori de enumerare a stării:
0: Nou (generat nou)1: Deschis (tratat activ de către operator)2: În așteptare (Se așteaptă răspunsul utilizatorului)3: OnPause (stare întreruptă)4: închis (arhivat)
3. Ștergeți un chat
Șterge definitiv un chat prin intermediul ID-ului său unic.
Solicitare
- Metoda: ȘTERGE
- URL:
/api/chat/chats/{id} - Autorizare:
Jeton de purtător
Răspuns (200 OK)
Returnează un HTTP 200 pentru a confirma ștergerea cu succes. Corpul este de obicei gol sau strict "OK".
4. Preluați mesajele de chat
Îndepărtează toate mesajele trimise și primite istoric într-un anumit chat.
Solicitare
- Metoda: GET
- URL:
/api/chat/chats/{chatId}/messages - Autorizare:
Jeton de purtător
Răspuns (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: Operator1: Client2: System Bot3: Cont Viber Business
Tipuri de mesaje:
0: Text1: Fotografie2: Fișier
5. Actualizați starea mesajelor
Marchează un mesaj (sau mai multe mesaje) într-un chat activ cu noi stări de livrare.
Solicitare
- Metoda: PUN
- URL:
/api/chat/messages/status - Autorizare:
Jeton de purtător - Headers:
Content-Type: application/json
Corpul:
{
"status": 3,
"messageIds": [1, 2, 3]
}
(Starea 3 marchează ID-urile mesajelor trimise ca „Citește”)