Discussions et messages
Méthodes API pour récupérer les métadonnées des conversations ChatHub, gérer les statuts et examiner les chaînes de messages historiques.
URL : https://chatapi.smsbat.com
1. Obtenez toutes les discussions
Récupérez une liste de discussions avec filtrage et pagination dynamiques.
Demande
- Méthode : OBTENIR
- URL :
/api/chat/chats - Autorisation : « Jeton du porteur » (obligatoire)
Paramètres de requête
| Paramètre | Tapez | Descriptif |
|---|---|---|
page | entier | Numéro de page. Par défaut : 1 |
par_page | entier | Articles par page. Par défaut : 20 |
recherche | chaîne | Recherche de texte (par exemple, nom, téléphone) |
source | entier | Énumération de la source du chat (par exemple « 1 » pour Viber Bot, « 2 » pour Telegram) |
date | dateheure | Récupère les discussions entre deux dates (nécessite deux clés de paramètre identiques dans l’URL). Ex : ?date=2026-01-28&date=2026-01-29 |
tg_user_id | entier | ID utilisateur du télégramme |
téléphone | chaîne | Numéro de téléphone |
statut | entier | 0 = Nouveau, 1 = Ouvert, 2 = En attente, 3 = En Pause, 4 = Fermé |
IDorganisation | entier | Affiner par organisation |
opérateurId | entier | Affiner par opérateur assigné |
Réponse (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. Modifier le statut du chat
Met à jour le statut attribué à une session de discussion spécifique.
Demande
- Méthode : METTRE
- URL :
/api/chat/statut - Autorisation :
Jeton du porteur - En-têtes :
Content-Type : application/json
Corps :
{
"id": 123,
"status": 1
}
Valeurs d’énumération de statut :
0: Nouveau (Nouvellement généré)1: Ouvert (Géré activement par l’opérateur)2: En attente (En attente de réponse de l’utilisateur)3: OnPause (état en pause)4: Fermé (Archivé)
3. Supprimer une discussion
Supprime définitivement une discussion via son identifiant unique.
Demande
- Méthode : SUPPRIMER
- URL :
/api/chat/chats/{id} - Autorisation :
Jeton du porteur
Réponse (200 OK) Renvoie un HTTP « 200 » pour confirmer la suppression réussie. Le corps est généralement vide ou strictement « OK ».
4. Récupérer les messages de discussion
Supprime tous les messages historiquement envoyés et reçus dans une discussion particulière.
Demande
- Méthode : OBTENIR
- URL :
/api/chat/chats/{chatId}/messages - Autorisation :
Jeton du porteur
Réponse (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
}
]
Auteurs :
- ‘0’ : Opérateur
- ‘1’ : Client
2: Bot système3: compte professionnel Viber
Types de messages :
0: Texte- ‘1’ : Photo
2: Fichier
5. Mettre à jour l’état des messages
Marque un message (ou plusieurs messages) dans une discussion active avec de nouveaux statuts de livraison.
Demande
- Méthode : METTRE
- URL :
/api/chat/messages/status - Autorisation :
Jeton du porteur - En-têtes :
Content-Type : application/json
Corps :
{
"status": 3,
"messageIds": [1, 2, 3]
}
(Le statut « 3 » marque les ID des messages envoyés comme « Lus »)