Messages API Logs
La page Journaux de l'API Messages vous permet de rechercher et de dépanner les messages envoyés via l'API Messages sur tous les canaux pris en charge, notamment WhatsApp, SMS, RCS, MMS, Viber, Messenger et Instagram. Utilisez cette page pour enquêter sur les problèmes de livraison, vérifier l'état des messages sur les différents canaux et télécharger les journaux à des fins d'analyse.
Remarque : Si vous envoyez des SMS par l'intermédiaire du SMS API, utiliser le Journaux de l'API SMS au lieu de cela.
Avant de commencer
- Les messages API sont disponibles pour 30 jours seulement
- Pour les journaux datant de plus de 30 jours, utilisez la fonction Reports API
- Il y a un délai de quelques minutes avant que les journaux n'apparaissent.
- Mettre en place un Réception de la livraison webhook pour des mises à jour en temps réel
Accès aux journaux de l'API Messages
- Se connecter à l'application Tableau de bord de l'API Vonage
- Naviguez jusqu'à Moniteur → Journaux
- Sélectionner Messages API Logs
Méthodes de recherche
La page Messages API Logs propose trois méthodes de recherche :
Plage de temps
Recherchez des messages au cours d'une période spécifique pour surveiller le trafic sur tous les canaux ou filtrer par fournisseur spécifique.
Filtres disponibles :
- Durée - Dernière heure, dernières 24 heures, derniers 7 jours, derniers 30 jours ou plage personnalisée
- Fournisseur - Any, WhatsApp, SMS, MMS, RCS, Viber, Messenger ou Instagram
- Direction - Messages sortants ou entrants
- Inclure le corps du message - Afficher le contenu du message dans les résultats
Numéro de téléphone / ID
Recherchez les messages envoyés à ou depuis des numéros de téléphone spécifiques ou des identifiants de comptes externes afin d'enquêter sur les problèmes des clients ou de vérifier la livraison.
Filtres disponibles :
- De - Le numéro de téléphone ou l'Account ID de l'expéditeur
- Pour - Le numéro de téléphone ou l'Account ID de destination
- Fournisseur - Any, WhatsApp, SMS, MMS, RCS, Viber, Messenger ou Instagram
- Direction - Sortie ou entrée
- Durée - Date d'envoi du message
- Inclure le corps du message - Afficher le contenu du message dans les résultats
Conseil : Pour WhatsApp, vous pouvez effectuer une recherche par numéro de téléphone ou par identifiant de compte professionnel WhatsApp (WABA ID).
ID du message
Recherchez un ou plusieurs messages spécifiques à l'aide de leur numéro d'identification unique. Cette méthode est idéale lorsque vous disposez d'identifiants de messages provenant de réponses d'API ou de webhooks.
Filtres disponibles :
- ID des messages - Un ou plusieurs UUID de message séparés par des virgules
- Direction - Sortie ou entrée
- Inclure le corps du message - Afficher le contenu du message dans les résultats
Remarque : L'API Messages utilise des identifiants de message au format UUID, qui diffèrent des identifiants de message de l'API SMS.
Travailler avec des résultats
Visualisation des détails du journal
Chaque entrée du journal contient des informations clés sur le message :
- ID du message - UUID unique pour le message
- Chaîne - Le fournisseur de messagerie (WhatsApp, SMS, RCS, etc.)
- De - Numéro de téléphone ou Account ID de l'expéditeur
- Pour - Numéro de téléphone de destination ou Account ID
- Statut - Statut de livraison (soumis, livré, lu, rejeté, etc.)
- L'heure - Date d'envoi du message ou de mise à jour de l'état
- Réseau - Opérateur de réseau mobile (pour les SMS/MMS/RCS uniquement)
- Prix - Coût du message
Comprendre l'état des messages
Les différents canaux prennent en charge des valeurs d'état différentes :
| Statut | Description | Canaux |
|---|---|---|
| soumis | Message accepté par Vonage | Toutes les chaînes |
| livrée | Message remis au destinataire | Toutes les chaînes |
| lire | Message lu par le destinataire | WhatsApp, Viber, Messenger, Instagram |
| rejetée | Message rejeté par le fournisseur | Toutes les chaînes |
| non livrable | Le message n'a pas été délivré | Toutes les chaînes |
Y compris le corps du message
Par défaut, le contenu des messages n'est pas affiché pour des raisons de confidentialité et de performance. Vérifiez l'option Inclure le corps du message pour afficher le contenu des messages dans vos résultats.
Important : Le contenu du corps du message n'est disponible que s'il a été stocké. Certains canaux peuvent ne pas conserver le contenu des messages en raison de leur politique de confidentialité.
Téléchargement des journaux
Exporter les résultats de la recherche au format CSV pour une analyse hors ligne ou la tenue d'un registre.
Pour télécharger les journaux :
- Effectuer une recherche en utilisant n'importe quelle méthode
- Cliquez sur Télécharger le CSV
- Le fichier CSV comprendra tous les champs des résultats de la recherche, y compris le corps du message si l'option est activée.
Remarque : Les téléchargements CSV sont limités aux résultats affichés. Pour les exportations en masse ou l'accès programmatique, utilisez la fonction Reports API.
Comprendre les délais d'enregistrement
- Journaux réguliers : Disponible dans les 2 à 5 minutes suivant l'envoi
- Les récépissés de livraison : Varie selon le canal :
- WhatsApp : Presque en temps réel (secondes)
- SMS/MMS : dépend de l'opérateur de réseau (de quelques secondes à quelques heures)
- RCS : Presque en temps réel (secondes)
- Canaux sociaux : Presque en temps réel (secondes)
- Mises à jour en temps réel : Utilisation Webhooks de réception des livraisons pour des notifications immédiates