Chats og beskeder
API-metoder til at hente ChatHub-samtale metadata, administrere statusser og gennemgå historiske meddelelseskæder.
URL: https://chatapi.smsbat.com
1. Få alle chats
Hent en liste over chats med dynamisk filtrering og paginering.
Anmodning
- Metode: FÅ
- URL: /api/chat/chats
- Godkendelse: "Bearer Token" (påkrævet)
Forespørgselsparametre
| Parameter | Skriv | Beskrivelse |
|---|---|---|
side |
heltal |
Sidenummer. Standard: 1 |
pr._side |
heltal |
Varer pr. side. Standard: 20 |
søg |
streng |
Tekstsøgning (f.eks. navn, telefon) |
kilde |
heltal |
Chat Kilde Enum (f.eks. "1" for Viber Bot, "2" for Telegram) |
dato |
datotid |
Henter chats mellem to datoer (kræver to identiske parameternøgler i URL'en). Eks: ?date=2026-01-28&date=2026-01-29 |
tg_user_id |
heltal |
Telegram bruger-id |
telefon |
streng |
Telefonnummer |
status |
heltal |
0 = Ny, 1 = Åben, 2 = Venter, 3 = OnPause, 4 = Lukket |
organisations-id |
heltal |
Indsnævre efter organisation |
operatorId |
heltal |
Indsnævre efter tildelt 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. Skift chatstatus
Opdaterer den tildelte status for en specifik chatsession.
Anmodning
- Metode: PUT
- URL: /api/chat/status
- Godkendelse: "Bearer Token".
- Overskrifter: Content-Type: application/json
Krop:
Status enum-værdier:
- 0: Ny (nyligt genereret)
- 1: Åben (behandles aktivt af operatøren)
- 2: Venter (afventer brugersvar)
- 3: OnPause (pausetilstand)
- 4: Lukket (arkiveret)
3. Slet en chat
Sletter en chat permanent via dens unikke ID.
Anmodning
- Metode: SLET
- URL: /api/chat/chats/{id}
- Godkendelse: "Bearer Token".
Svar (200 OK)
Returnerer en HTTP 200 for at bekræfte vellykket sletning. Brødteksten er typisk tom eller strengt taget "OK".
4. Hent chatbeskeder
Dumper alle meddelelser, der historisk er sendt og modtaget i en bestemt chat.
Anmodning
- Metode: FÅ
- URL: /api/chat/chats/{chatId}/messages
- Godkendelse: "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-konto
Meddelelsestyper:
- 0: Tekst
- 1: Foto
- 2: Fil
5. Opdater meddelelsesstatus
Markerer en besked (eller flere beskeder) i en aktiv chat med nye leveringsstatusser.
Anmodning
- Metode: PUT
- URL: /api/chat/messages/status
- Godkendelse: "Bearer Token".
- Overskrifter: Content-Type: application/json
Krop:
(Status3 markerer de sendte besked-id'er som "Læst")