Introduction

Ces APIs permettent le suivi précis de l'état des communications sortantes (e-mails, SMS) et la consultation de leur contenu.

Récupérer par API les informations et le contenu d'un message

Endpoint : GET /v1/messages
Objectif : Cet outil vous offre une vue d'ensemble paginée de tous les messages que vous avez envoyés. Il est utile pour un suivi global ou pour trouver des messages spécifiques en masse.
Comment l'utiliser ? Vous pouvez affiner votre recherche grâce à des critères de filtrage:
- Canal (channel) : Filtrez par type de communication (email, SMS, notification push).
- Période (after, before) : Délimitez votre recherche par une date et heure de début ou de fin.
- ID Campagne (campaign_id) : Filtrez les messages appartenant à une campagne spécifique.
- Destinataire (recipient): Permet de rechercher des messages envoyés à une adresse email ou un numéro de téléphone précis.
- Pagination (limit, page) : Gérez la quantité de résultats retournés par page (de 5 à 200, par défaut 20) et naviguez entre les pages.
Ce que vous recevez : Une liste d'objets "message". Chaque message contient des informations comme son identifiant (id), le canal (channel), la date d'envoi (date), des détails sur la campagne associée, les rapports de livraison (delivery_reports) et les réactions des destinataires (reactions comme les clics).

Endpoint : GET /v1/messages/{id}
Objectif : Lorsque vous avez l'identifiant unique d'un message envoyé, cette API vous donne accès à toutes les informations détaillées le concernant, y compris son statut et ses métadonnées.
Comment l'utiliser ? Fournissez simplement l'identifiant (id) du message que vous souhaitez consulter.
Ce que vous recevez : Un objet JSON contenant toutes les informations détaillées du message.

Endpoint : GET /v1/messages/{id}/content
Objectif : Cet outil permet de récupérer le contenu exact d'un message qui a été envoyé.
Comment l'utiliser ? Indiquez l'identifiant (id) du message dont vous voulez voir le contenu.
Ce que vous recevez : Le contenu du message, prioritairement en HTML si disponible pour les emails, sinon en texte brut.