Csevegés és üzenetek
API-módszerek a ChatHub-beszélgetés metaadatainak lekéréséhez, az állapotok kezeléséhez és a történeti üzenetláncok áttekintéséhez.
URL: https://chatapi.smsbat.com
1. Get All Chats
Kérje le a csevegések listáját dinamikus szűréssel és oldalszámozással.
Kérés
- Módszer: GET
- URL: /api/chat/chats
- Engedélyezés: "Bearer Token" (kötelező)
Lekérdezési paraméterek
| Paraméter | Típus | Leírás |
|---|---|---|
oldal |
"egész" | Oldalszám. Alapértelmezett: "1" |
| "oldalonként" | "egész" | Elemek oldalanként. Alapértelmezett: "20" |
keresni |
"string" | Szöveges keresés (pl. név, telefon) |
| "forrás" | "egész" | Chat Source Enum (pl. 1 a Viber Botnál, 2 Telegramnál) |
| "dátum" | "dátumidő" | Lekéri a csevegéseket két dátum között (két azonos paraméterkulcs szükséges az URL-ben). Pl.: ?date=2026-01-28&date=2026-01-29 |
tg_user_id |
"egész" | Telegram felhasználói azonosító |
| "telefon" | "string" | Telefonszám |
| "állapot" | "egész" | 0 = Új, 1 = Nyitott, 2 = Várakozás, 3 = Szünet bekapcsolva, 4 = Zárt |
organizationId |
egész szám |
Szervezet szerinti szűkítés |
operatorId |
egész szám |
Szűkítés hozzárendelt operátor szerint |
Válasz (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. Csevegés állapotának módosítása
Frissíti egy adott csevegési munkamenet hozzárendelt állapotát.
Kérés
- Módszer: PUT
- URL: /api/chat/status
- Engedélyezés: Bearer Token
- Fejlécek: Tartalomtípus: Application/json
Test:
Status Enum értékek:
- "0": Új (újonnan generált)
- 1: Nyitott (A kezelő aktívan kezeli)
- 2: Várakozás (Felhasználói válaszra vár)
- 3: OnPause (szüneteltetett állapot)
- 4: Lezárt (Archivált)
3. Csevegés törlése
Véglegesen törli a csevegést az egyedi azonosítójával.
Kérés
- Módszer: TÖRLÉS
- URL: /api/chat/chats/{id}
- Engedélyezés: Bearer Token
Válasz (200 OK) A sikeres törlés megerősítéséhez egy HTTP "200" értéket ad vissza. A törzs általában üres, vagy szigorúan "OK" van.
4. Csevegési üzenetek letöltése
Kiírja az adott csevegésben korábban elküldött és fogadott összes üzenetet.
Kérés
- Módszer: GET
- URL: /api/chat/chats/{chatId}/messages
- Engedélyezés: Bearer Token
Válasz (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: Kezelő
- 1: Ügyfél
- 2: Rendszerbot
- 3: Viber Business Account
Üzenettípusok:
- 0: Szöveg
- 1: Fénykép
- 2: Fájl
5. Frissítse az üzenetek állapotát
Megjelöl egy üzenetet (vagy több üzenetet) egy aktív csevegésen belül új kézbesítési állapotokkal.
Kérés
- Módszer: PUT
- URL: /api/chat/messages/status
- Engedélyezés: Bearer Token
- Fejlécek: Tartalomtípus: Application/json
Test:
(A "3" állapot az elküldött üzenetek azonosítóit "Olvasott"-ként jelöli)