Chattar och meddelanden
API-metoder för att hämta ChatHub-konversationsmetadata, hantera statusar och granska historiska meddelandekedjor.
URL: https://chatapi.smsbat.com
1. Få alla chattar
Hämta en lista över chattar med dynamisk filtrering och sidnumrering.
Begäran
- Metod: GET
- URL: /api/chat/chats
- Auktorisering: "Bearer Token" (obligatoriskt)
Frågeparametrar
| Parameter | Skriv | Beskrivning |
|---|---|---|
sida |
heltal |
Sidnummer. Standard: 1 |
per_sida |
heltal |
Objekt per sida. Standard: 20 |
sök |
sträng |
Textsökning (t.ex. namn, telefon) |
källa |
heltal |
Chattkälla Enum (t.ex. "1" för Viber Bot, "2" för Telegram) |
datum |
datetime |
Hämtar chattar mellan två datum (kräver två identiska parameternycklar i webbadressen). Ex: ?date=2026-01-28&date=2026-01-29 |
tg_user_id |
heltal |
Telegram Användar-ID |
telefon |
sträng |
Telefonnummer |
status |
heltal |
0 = Ny, 1 = Öppen, 2 = Väntar, 3 = PåPaus, 4 = Stängd |
organisationsId |
heltal |
Begränsa efter organisation |
operatorId |
heltal |
Begränsa efter tilldelad operatör |
Svar (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. Ändra chattstatus
Uppdaterar den tilldelade statusen för en specifik chattsession.
Begäran
- Metod: PUT
- URL: /api/chat/status
- Auktorisering: "Bearer Token".
- Rubriker: Content-Type: application/json
Kroppen:
Statusenumvärden:
- 0: Ny (nyligen genererad)
- 1: Öppen (hanteras aktivt av operatören)
- 2: Väntar (Väntar på användarsvar)
- 3: OnPause (pausat tillstånd)
- 4: Stängd (arkiverad)
3. Ta bort en chatt
Raderar en chatt permanent via dess unika ID.
Begäran
- Metod: DELETE
- URL: /api/chat/chats/{id}
- Auktorisering: "Bearer Token".
Svar (200 OK) Returnerar en HTTP "200" för att bekräfta lyckad radering. Brödtexten är vanligtvis tom eller strikt "OK".
4. Hämta chattmeddelanden
Dumpar alla meddelanden som historiskt har skickats och tagits emot inom en viss chatt.
Begäran
- Metod: GET
- URL: /api/chat/chats/{chatId}/messages
- Auktorisering: "Bearer Token".
Svar (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: Operatör
- 1: Klient
- 2: Systembot
- 3: Viber Business Account
Meddelandetyper:
- 0: Text
- 1: Foto
- 2: Fil
5. Uppdatera meddelandestatus
Markerar ett meddelande (eller flera meddelanden) i en aktiv chatt med nya leveransstatusar.
Begäran
- Metod: PUT
- URL: /api/chat/meddelanden/status
- Auktorisering: "Bearer Token".
- Rubriker: Content-Type: application/json
Kroppen:
(Status3 markerar skickade meddelande-ID:n som "Läst")