Biseda dhe Mesazhe
Metodat API për marrjen e meta të dhënave të bisedës ChatHub, menaxhimin e statuseve dhe rishikimin e zinxhirëve historikë të mesazheve.
URL: https://chatapi.smsbat.com
1. Merr të gjitha bisedat
Merrni një listë bisedash me filtrim dhe faqezim dinamik.
kërkesë
- ** Metoda: ** MERRNI
- URL: /api/chat/chats
- Autorizimi: 'Shenja mbajtës' (kërkohet)
Parametrat e pyetjes
| Parametri | Lloji | Përshkrimi |
|---|---|---|
faqe |
numër i plotë |
Numri i faqes. Parazgjedhja: 1 |
për_faqe |
numër i plotë |
Artikujt për faqe. Parazgjedhja: 20 |
kërkim |
varg |
Kërkimi i tekstit (p.sh., emri, telefoni) |
burimi |
numër i plotë |
Enum burimi i bisedës (p.sh. 1 për Viber Bot, 2 për Telegram) |
| 'data' | 'data' | Merr bisedat midis dy datave (kërkon dy çelësa parametrash identikë në URL). Shembull: ?datë=2026-01-28&datë=2026-01-29 |
tg_user_id |
numër i plotë |
ID e përdoruesit të Telegramit |
telefon |
varg |
Numri i telefonit |
| "statusi" | numër i plotë |
0 = E re, 1 = Hapur, 2 = Në pritje, 3 = Në pauzë, 4 = Mbyllur |
Id i organizatës |
numër i plotë |
Ngusht nga organizata |
OperatorId |
numër i plotë |
Ngushtoni sipas operatorit të caktuar |
Përgjigje (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. Ndrysho statusin e bisedës
Përditëson statusin e caktuar të një seance bisede specifike.
kërkesë
- Metoda: PUT
- URL: /api/chat/status
- Autorizimi: Bearer Token
- Titujt: Lloji i përmbajtjes: aplikacion/json
Trupi: KODI_BLOCK_1
Vlerat e numrit të statusit:
- 0: E re (e krijuar rishtazi)
- 1: E hapur (trajtohet në mënyrë aktive nga operatori)
- 2: Në pritje (në pritje të përgjigjes së përdoruesit)
- 3: Në pauzë (gjendje në pauzë)
- 4: E mbyllur (e arkivuar)
3. Fshi një Chat
Fshin përgjithmonë një bisedë përmes ID-së së tij unike.
kërkesë
- ** Metoda: ** FSHIJE
- URL: /api/chat/chats/{id}
- Autorizimi: Bearer Token
Përgjigje (200 OK)
Kthen një HTTP 200 për të konfirmuar fshirjen e suksesshme. Trupi zakonisht është bosh ose rreptësisht "OK"".
4. Merr mesazhet e bisedës
Hidh të gjitha mesazhet e dërguara dhe të marra historikisht brenda një bisede të veçantë.
kërkesë
- ** Metoda: ** MERRNI
- URL: /api/chat/chats/{chatId}/messages
- Autorizimi: Bearer Token
Përgjigje (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: Operator
- 1: Klient
- 2: Sistemi Bot
- 3: Llogaria e biznesit në Viber
Llojet e mesazheve:
- 0: Tekst
- 1: Foto
- 2: Skedar
5. Përditëso statusin e mesazheve
Shënon një mesazh (ose mesazhe të shumta) brenda një bisede aktive me statuse të reja dërgimi.
kërkesë
- Metoda: PUT
- URL: /api/chat/messages/status
- Autorizimi: Bearer Token
- Titujt: Lloji i përmbajtjes: aplikacion/json
Trupi:
KODI_BLOCK_3
(Statusi 3 shënon ID-të e mesazhit të dërguar si "Lexo")