Twilio WhatsApp
Twilio is a partner that provides WhatsApp APIs. If you already have a Twilio Whatsapp API account, you can integrate it with Engagespot just by connecting your account.
Unique Identifier
Each provider is identified by a unique identifier. Unique identifier of Twilio WhatsApp provider is twilio_whatsapp
Enabling Twilio provider
To enable Twilio provider for WhatsApp, login to your Engagespot Console, goto Channels -> WhatsApp and enable Twilio. The following details are required from your Twilio account.
| Key | Description | Required |
|---|---|---|
| TWILIO_ACCOUNT_SID | You can find your account SID from your account info page in Twilio dashboard. | Yes |
| TWILIO_AUTH_TOKEN | You can find your auth token from your account info page in Twilio dashboard. | Yes |
| TWILIO_FROM_NUMBER | The number you purchased in Twilio to send SMS. Should be in the format with country code, without any spaces. For eg: +16453454679 | Yes |
User Profile Requirement
Twilio WhatsApp Provider uses the phoneNumber property in your User's profile. That means, you should update the phoneNumber property in your User's profile. The phoneNumber should have country code without any spaces or special characters. Example +919988776655 is a valid number whereas (457)-746-846 is an invalid number.
To learn how to update your user's phone number in Engagespot, read our REST API or SDK documentation of your language of choice.
Advanced Delivery Tracking
If you want the delivery status of your WhatsApp notifications to be available in Engagespot, you have to specify a call back URL in your Twilio account.
-
First off, you’ll need the URL from the system from which you want to receive the events. for that got to Engagespot Console -> Channels -> WhatsApp -> Configured Providers -> Twilio Instance -> Edit You can see the callback URL like this. Just copy this callback URL.
-
As the next step, in your Twilio dashboard, look for a section titled Message Events. Check all events, so all those events can be tracked by Engagespot.
What events can be tracked?
Currently, Engagespot tracks the following events from your Twilio WhatsApp API.
| Event | Description |
|---|---|
| sent | This is a status from Engagespot. This means, your notification has been successfully accepted by Twilio API. But that may not guarantee delivery. |
| delivered | Your WhatsApp message has been delivered to your user, but has not been seen yet |
| seen | Your WhatsApp message was seen by the user. This event is tracked only for users who have turned on read reciepts in their WhatsApp account |
| discarded | For some reason, your message was not delivered. There will be an explanation along with the status |
Overriding Twilio Configuration and notification data via API
Twilio provider allows you to override all the above configurations and data while sending a notification through Engagespot API, using the https://api.engagespot.co/v3/notifications endpoint.
To override the configurations, you must supply them via override.twilio_whatsapp parameter of the above API. Within the override parameter, you can supply any object that we'll directly pass to Twilio WhatsApp API Body See doc.