Exotel
This guide demonstrates how to integrate Exotel with CleverTap for WhatsApp communication
Note
This integration is completed by Exotel and they are dedicated to maintaining and enhancing it. The CleverTap <> Exotel integration has undergone stringent testing to ensure its seamless functionality. In the event of any questions or issues, users must rely on Exotel for support and resolution.
Introduction
CleverTap users can now leverage the following WhatsApp capabilities of Exotel to communicate with their customers. Communications include:
- Sending just-in-time offers to customers to drive purchases
- Gathering feedback on the services
- Keeping customers informed and more
Prerequisites for Integration
The following are the prerequisites:
- You must have WhatsApp add-on enabled on the Clevertap account in addition to the basic or essentials price plan.
- Ensure that WhatsApp onboarding for the phone number to be used with CleverTap is completed.
- Ensure that you have the infra URL and credentials from Exotel.
If you want to activate a new phone number with WhatsApp business API via Exotel, contact your account manager or email [email protected].
Integrate Exotel with CleverTap
This process involves the following three steps:
- Find Exotel Details
- Configure CleverTap Dashboard
- Set up CleverTap callbacks in Exotel
Find Exotel Details
We recommend that you keep the following information handy before starting with configuration on the CleverTap dashboard:
- API Credentials: To obtain the API KEY, API TOKEN, and Account sid, log in to your Exotel account and navigate to the Settings > API Settings page from the Exotel dashboard.
Configure CleverTap Dashboard
To configure the CleverTap dashboard:
- Navigate to Settings > Channels > WhatsApp > WhatsApp Connect from the CleverTap dashboard.
- Click + Add Provider and select Generic (Other) from the dropdown.
- Enter the following details:
Field | Description |
---|---|
Provider | Select Other (Generic) from the dropdown list. |
Nickname | Enter the nickname as Exotel |
WhatsApp Business Number | Enter your phone number onboarded to WhatsApp API by Exotel. |
Request Type | Ensure the Request Type is Post |
HTTP Endpoint | Enter HTTP Endpoint as: https://api.in.exotel.com/v2/accounts/Exotel/messages/clevertap/whatsapp Ensure that you replace Exotel with your Account SID. |
Authentication | Select Basic Authentication and enter the Username and Password (From step 1) |
- Select the Mark this as default checkbox to make this service provider the default provider to send a WhatsApp message.
- To send an automatic reply to users who message on WhatsApp, but are not tracked on the CleverTap dashboard, you can select the Set auto reply for users not tracked on CleverTap checkbox.
- (Optional) You can set the Maximum Concurrent API requests anywhere between 30 to 1000 requests. Consider your requirements and the provider's limitations to define this value.
- Send a Test WhatsApp notification:
To ensure that the integration is successful:
a. Click the Send Test WhatsApp hyperlink before you start creating WhatsApp campaigns and journeys. To begin with, activate the conversation window by following any one of the following methods:
i. Save the business contact and send a WhatsApp message to that number.
ii. Copy and share the link with the user you want to send the test notification to. Further, ask the user to click on the link and send a WhatsApp message to initiate a conversation.
iii. If you want to send a test notification to yourself, you can click the link and initiate a WhatsApp conversation.
b. Enter the following details:
Country Code and Mobile Number: Enter the country code and mobile number of the user to whom you want to send the test message.
Message: Here, you can enter the sample text message you want to send to the test user. Once you click on Send Test, the success or failure response displays on the dashboard. If the message is not delivered, you can copy the response payload and share it with the Gupshup team to debug the issue.
- Click Save to save the details.
Set up CleverTap Callbacks in Exotel
Further, share the following details of your WhatsApp-enabled phone number with Exotel support at *[email protected] for enabling WhatsApp integration with Clevertap.
- URL: Exotel.abc.net port XXXX
- Username: Abcorp
- Password: XXXXXXXX
- Phone number: 734550771X
- Account SID: Abc_1
- Delivery Report Callback URL
- Inbound Message Callback URL
You can copy the Delivery Report Callback URL and Inbound Message Callback URL from the CleverTap dashboard.
Upon receiving the request, the support team configures the callbacks with your WhatsApp phone number, and the integration is confirmed (within 24 hours) post which you can proceed with creating campaigns.
Note:
To use templates whitelisted on the META business manager dashboard provided by Exotel, you need to add them to the Clevertap dashboard.
For more information and queries about the Exotel integration, you can write to [email protected].
Adding Message Template
Naming WhatsApp Templates
Template names and language variants must be unique for each provider configuration. This means that you can use the same template name once for each provider configuration.
For example, if you have multiple provider configurations, such as Phone_1, phone_2, you can use the same template name once within Phone_1 and Phone_2.
To create WhatsApp campaigns, you need to have pre-approved WhatsApp message templates saved in the CleverTap dashboard. Follow the procedure below to add the templates.
- Navigate to Settings > Channels > WhatsApp > WhatsApp Connect > Provider Nickname in the CleverTap dashboard. Further, Select the Templates option and click +Template.
- Enter the template name in the namespace field.
- Choose the type of template header (Text or Media). For Media headers, you can use Image, Video, Document, and Location.
- You can choose to use the Limited Time Offer template for your message. For more information, refer to Limited Time Offer Template..
- Enter the message content.
- You can also add a Footer text and a Button (Quick Reply or a Call To Action).
- You can also choose the language in which you want to display the message.
- Click Save Template.
Testing a Message Template
You can send a test message using the saved templates from the CleverTap dashboard as follows:
- Right-click the ellipsis below the template.
- Click Send Test.
- Select the test profiles or manually enter the mobile number to whom you want to send the test message and click Send Test.
The success or failure response is displayed on the dashboard. If the message is not delivered, you can copy the response payload and share it with the Exotel team to debug the issue, as shown in the following figure:
Create Campaign
To create a WhatsApp campaign using Exotel as the provider, refer to Create a WhatsApp Campaign for detailed instructions.
Creating a Journey
To create a WhatsApp journey using ValueFirst as the provider, refer to Create a WhatsApp Journey for detailed instructions.
Updated 6 months ago