Συνομιλίες και μηνύματα
Μέθοδοι API για τη λήψη μεταδεδομένων συνομιλίας ChatHub, τη διαχείριση καταστάσεων και τον έλεγχο ιστορικών αλυσίδων μηνυμάτων.
URL: https://chatapi.smsbat.com
1. Λήψη όλων των συνομιλιών
Λάβετε μια λίστα συνομιλιών με δυναμικό φιλτράρισμα και σελιδοποίηση.
αίτημα
- Μέθοδος: ** GET
- URL: /api/chat/chats
- Εξουσιοδότηση:** Bearer Token (Απαιτείται)
Παράμετροι ερωτήματος
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
σελίδα |
«ακέραιος» | Αριθμός σελίδας. Προεπιλογή: 1 |
| "ανά_σελίδα" | «ακέραιος» | Στοιχεία ανά σελίδα. Προεπιλογή: 20 |
αναζήτηση |
χορδή |
Αναζήτηση κειμένου (π.χ. όνομα, τηλέφωνο) |
| «πηγή» | «ακέραιος» | Αριθμός πηγής συνομιλίας (π.χ. "1" για Viber Bot, "2" για Telegram) |
| «ημερομηνία» | «ημερομηνία» | Ανακτά συνομιλίες μεταξύ δύο ημερομηνιών (απαιτούνται δύο πανομοιότυπα κλειδιά παραμέτρων στη διεύθυνση URL). Π.χ.: ?date=2026-01-28&date=2026-01-29 |
tg_user_id |
«ακέραιος» | Αναγνωριστικό χρήστη Telegram |
| «τηλέφωνο» | χορδή |
Αριθμός τηλεφώνου |
| «κατάσταση» | «ακέραιος» | 0 = Νέο, 1 = Άνοιγμα, 2 = Αναμονή, 3 = Σε Παύση, 4 = Κλειστό |
organizationId |
ακέραιος |
Περιορισμός κατά οργανισμό |
| "αναγνωριστικό χειριστή" | ακέραιος |
Περιορισμός από τον εκχωρημένο τελεστή |
Απάντηση (200 ΟΚ)
{
"total": 124,
"items": [
{
"id": 123,
"theme": "Support Ticket #491",
"operator": {
"id": 21,
"name": "Jane",
"photo": "url_to_photo.png"
},
"chatStatus": 1,
"countUnread": 3
}
]
}
2. Αλλαγή κατάστασης συνομιλίας
Ενημερώνει την εκχωρημένη κατάσταση μιας συγκεκριμένης συνεδρίας συνομιλίας.
αίτημα
- Μέθοδος: PUT
- URL: /api/chat/status
- Εξουσιοδότηση: Bearer Token
- Κεφαλίδες: Τύπος περιεχομένου: εφαρμογή/json
Σώμα:
Αριθμός τιμών κατάστασης:
- 0: Νέο (νέα δημιουργία)
- 1: Ανοιχτό (τον χειρίζεται ενεργά ο χειριστής)
- 2: Αναμονή (Αναμονή απάντησης χρήστη)
- 3: Σε παύση (κατάσταση σε παύση)
- 4: Κλειστό (Αρχειοθετημένο)
3. Διαγράψτε μια συνομιλία
Διαγράφει οριστικά μια συνομιλία μέσω του μοναδικού αναγνωριστικού της.
αίτημα
- Μέθοδος: ΔΙΑΓΡΑΦΗ
- URL: /api/chat/chats/{id}
- Εξουσιοδότηση: Bearer Token
Απάντηση (200 ΟΚ)
Επιστρέφει ένα HTTP 200 για επιβεβαίωση της επιτυχούς διαγραφής. Το σώμα είναι συνήθως κενό ή αυστηρά "ΟΚ"".
4. Ανάκτηση μηνυμάτων συνομιλίας
Καταργεί όλα τα ιστορικά μηνύματα που στάλθηκαν και ελήφθησαν σε μια συγκεκριμένη συνομιλία.
αίτημα
- Μέθοδος: ** GET
- URL: /api/chat/chats/{chatId}/messages
- Εξουσιοδότηση:** Bearer Token
Απάντηση (200 ΟΚ)
[
{
"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: Χειριστής
- 1: Πελάτης
- 2: System Bot
- 3: Επαγγελματικός λογαριασμός Viber
Τύποι μηνυμάτων:
- 0: Κείμενο
- 1: Φωτογραφία
- 2: Αρχείο
5. Ενημέρωση κατάστασης μηνυμάτων
Επισημαίνει ένα μήνυμα (ή πολλά μηνύματα) μέσα σε μια ενεργή συνομιλία με νέες καταστάσεις παράδοσης.
αίτημα
- Μέθοδος: PUT
- URL: /api/chat/messages/status
- Εξουσιοδότηση: Bearer Token
- Κεφαλίδες: Τύπος περιεχομένου: εφαρμογή/json
Σώμα:
(Κατάσταση3 επισημαίνει τα αναγνωριστικά των απεσταλμένων μηνυμάτων ως "Αναγνωσμένα")