Cloudapi WhatsApp
Cloudapi provides a simple and efficient way to send notifications via WhatsApp. If you already have a Cloudapi WhatsApp account, you can easily integrate it with Engagespot by providing the required configuration details.
Unique Identifier
Each provider is identified by a unique identifier. The unique identifier of the Cloudapi WhatsApp provider is cloudapi_whatsapp.
Enabling Cloudapi provider
To enable the Cloudapi provider for WhatsApp, follow these steps:
- Login to your Engagespot Console.
- Go to Channels -> WhatsApp.
- Enable Cloudapi WhatsApp.
The following details are required from your Cloudapi account:
| Key | Description | Required |
|---|---|---|
| accessToken | Your Cloudapi permanent access token. | Yes |
| version | Version of the Cloudapi that you are using. | Yes |
| phoneNumberId | The Phone Number ID for WhatsApp API. | Yes |
User Profile Requirement
Cloudapi WhatsApp Provider uses the phoneNumber property in your User's profile. Therefore, you must update the phoneNumber property in your User's profile. The phoneNumber should include the country code without any spaces or special characters. For example, +919988776655 is a valid number, whereas (457)-746-846 is invalid.
To learn how to update your user's phone number in Engagespot, refer to our REST API or the SDK documentation of your preferred language.
Advanced Delivery Tracking
To receive delivery status updates for WhatsApp notifications in Engagespot, you must specify a callback URL in your Cloudapi account.
Steps to Set Up Delivery Tracking:
-
First, obtain the callback URL from the Engagespot Console:
- Go to Channels -> WhatsApp -> Configured Providers -> Cloudapi Instance -> Edit.
- Copy the callback URL displayed.
-
In your Cloudapi dashboard, locate the section for Webhook URL / Callback Configuration.
- Paste the copied callback URL into the appropriate input field and save the changes.
What Events Can Be Tracked?
Currently, Engagespot tracks the following events from the Cloudapi WhatsApp API:
| Event | Description |
|---|---|
| sent | The notification has been successfully accepted by the Cloudapi API, but it may not guarantee delivery. |
| delivered | The WhatsApp message has been delivered to the user, but they may not have seen it yet. |
| seen | The WhatsApp message has been seen by the user (only tracked if the user has enabled "Read Receipts" in WhatsApp). |
| discarded | The message was not delivered for some reason. An explanation will accompany the status. |
Overriding Cloudapi Configuration and Notification Data via API
Cloudapi allows you to override the default configurations when sending a notification through Engagespot API. You can pass these configurations using the override.cloudapi_whatsapp parameter in the https://api.engagespot.co/v3/notifications endpoint.
Within the override parameter, you can supply any object that will be directly passed to the Cloudapi WhatsApp API. This allows for flexibility in your integration.
For more details, refer to the Cloudapi documentation.