Introduction
You can automate the sending of transactional messages (SMS or email) using an API. A dedicated documentation provides full details of the parameters required for this operation.
Sending a transactional message via API
Campaign preparation
Before any sending, your application campaign must be created. This can be done directly on our platform or programmatically via API.
Channel selection and Sending
Once the campaign is ready, you can send messages by email or SMS, depending on the channel defined for your campaign.
Sending is done by calling the endpointPOST /message.
Key parameters for sending:
-
code: Unique campaign identifier to be used. This code is available on the platform or via the API when the campaign is created. -
channel: Specifies the sending channel chosen for the campaign, either"email", or"sms". -
mobileoremail: Indicates the message destination (cell phone number for SMS, e-mail address for e-mail). The exact parameter depends on thechannelselected.
The detailed API documentation will provide you with a precise description of all the other parameters and their usefulness.
Feedback monitoring and analysis
After messages have been sent, dedicated endpoints are available to analyze feedback and interactions with these communications.