Introduction

These APIs enable precise monitoring of the status of outgoing communications (e-mails, SMS) and consultation of their content.

Recover message information and content via API

Recover list of all sent messages

• Endpoint: GET /v1/messages
• Purpose: This tool gives you a paginated overview of all the messages you've sent. It's useful for global tracking or for finding specific messages en masse.
• How to use it You can refine your search with filter criteria:
  • Channel (channel) : Filter by type of communication (email, SMS, push notification).
  • Period (after, before) : Delimit your search by a start or end date and time.
  • Campaign ID () : Filter messages belonging to a specific campaign.
  • Recipient (): Search for messages sent to a specific email address or phone number.
  • Pagination (, page): Manage the quantity of results returned per page (from 5 to 200, default 20) and navigate between pages.
• What you receive: A list of "message" objects. Each message contains information such as its identifier (id), channel (channel), date sent (date), details of the associated campaign, delivery reports (delivery_reports) and recipient reactions (reactions such as clicks).

Recover details of a specific message

• Endpoint: GET /v1/messages/{id}
• Purpose: Once you have the unique identifier of a sent message, this API gives you access to all the detailed information about it, including its status and metadata.
• How to use it: Simply provide the identifier (id) of the message you wish to view.
• What you receive: A JSON object containing all the detailed information about the message.

Recover message content

• Endpoint: GET /v1/messages/{id}/content
• Objective: This tool retrieves the exact content of a message that has been sent.
• How to use it: Specify the identifier (id) of the message whose contents you want to see.
• What you receive:The content of the message, prioritized in HTML if available for emails, otherwise in plain text.