User DocumentationDeveloper DocumentationPartner GuideWhat's New
Request DemoSign In

Exotel

Suggest Edits

Introduction

CleverTap users can now leverage the SMS capabilities of Exotel to communicate with their customers for the following seamlessly:

  • Sending just in time offers to customers to drive purchases
  • Gathering feedback on the services
  • Keeping customers informed and more

In addition, businesses can automate sales and marketing engagements by sending personalized texts through ISO-certified secure SMS pipes.

Prerequisites for Integration

The following are the prerequisites:

  • You must have an account with SMS permissions from Exotel.
  • You must have a CleverTap account with SMS setup enabled.
  • You must have DLT-approved templates if the region of your account is in India.

Integrate Exotel with CleverTap

This process involves the following four steps:

  1. Configure Exotel Dashboard
  2. Find Exotel Details
  3. Configure CleverTap Dashboard
  4. Send a Test SMS

Configure Exotel Dashboard

Per the DLT mandate, you must upload the following details to the Settings page of your Exotel Account to send an SMS:

  • Entity ID: It is the unique ID provided to every business.
  • Sender ID: The six-digit ID from which the SMS is sent.
  • Template ID: It is the unique ID for each transactional or promotional SMS that you want to use.
  • Template Details: These are the DLT-approved templates for the messages you want to send to your customers. You need to upload it to the Exotel dashboard.
  • SMS Type: It is used to classify different types of messages that you want to send to your customers. The following are the options available: transactional, service explicit, service implicit, and promotional.

📘

Exotel Support

For more information and queries pertaining to Exotel, visit Exotel Support Center.

Find Exotel Details

We recommend that you keep the following information handy before starting with configuration on the CleverTap dashboard:

  • Account sid and API Credentials: To obtain this information, navigate to the API > API Settings page from the Exotel dashboard.
2874

Find Exotel Account SID and API Credentials

  • Sender ID: To obtain this information, navigate to Settings > Sender ID from the Exotel dashboard.
2868

Find Exotel Sender ID

2506

Find Exotel Entity ID

2876

Find Exotel DLT Template ID

Configure CleverTap Dashboard:

To configure the CleverTap dashboard:

  1. Navigate to Settings > Engage > Channels > SMS from the CleverTap dashboard.
  2. Click + Add Provider. The Add SMS provider screen displays.
884

Add SMS Provider Credentials in CleverTap Dashboard

  1. Enter the following details:

Field

Description

Provider

Select Exotel from the dropdown list.

Nickname

Enter the nickname for the SMS Provider to uniquely identify it.

Callback URL

Enter the URL where status callbacks must be posted after the SMS is sent.

Account SID

Enter your account identifier. For more information, refer to Step 2.

API Key

Enter API Key (Username) obtained in the Find Exotel Details step.

API Token

Enter API Token (Password) obtained in the Find Exotel Details step.

Region

From/Sender ID

  • It is the ID from which the SMS is sent.
  • The format of this field is as follows:
    / where
    • is the Exotel Virtual
    • Number/ExoPhone through which you send the SMS.

SMS Type

  • Select the None from the dropdown if you have uploaded your templates on the Exotel dashboard.
  • It is used to skip template addition on Exotel Dashboard and configure SMS type based on the template registered on DLT in India.
  • The following are the options available:
    • None
    • transactional: Indicates that SMS consists of OTP or Service Implicit content.
    • transactional_opt_in: Indicates that the SMS consists of Service Explicit content.
    • promotional: Indicates that the SMS consists of Promotional content with a numeric header.
  • Default value for this field is None.
  • If not set or incorrectly passed, Exotel will look up if the content matches Templates added on Exotel for fetching SMS Type and DLT details.

DLT Entity ID

  • Indicates the Content Template ID against the SMS body registered with Distributed Ledger Technology (DLT) portal of operators in India.
  • It is optional if you configure it on the Exotel dashboard. If not configured, enter the DLT-approved Entity ID for your legal entity here.
  • It is applicable only for SMS sent by Indian businesses to Indian destination numbers.

Template ID

  • It is optional if you configure it on the Exotel dashboard. Enter the DLT-approved Template ID for your legal entity if not configured.
  • It is applicable only for SMS sent by Indian businesses to Indian destination numbers.
  1. Select the Template ID checkbox.
  2. Select the Mark this as default checkbox to make this SMS provider the default provider to send the SMS.
  3. Click Save to save the details.

Send a Test SMS

To ensure that the integration is successful:

  1. Click the Send Test SMS hyperlink before you start creating SMS campaigns and journeys.
  2. Enter the following details:
    • Country Code and Mobile number: Enter the country code and mobile number to which you want to send the message.
    • Message: This is a test message powered by Exotel.
2232

Send a Test SMS

Create Campaigns and Journeys

Now that your integration is successful, you can now create SMS campaigns and journeys.

Troubleshooting

Failed to send out test notifications

Issue
The following error displays when saving Exotel credentials in the CleverTap dashboard

1536

Test Notifications Failed

Resolution
The following are the steps to resolve the issue:

  1. Find your Exotel Credentials. Ensure that the keys are added correctly as they are case-sensitive.
  2. Raise the CleverTap Support Request to get the error code if the issue persists.
  3. Connect with the Exotel support team to get this resolved after you receive the error code from the CleverTap support team.

📘

Encoding

The messages sent out from CleverTap are encoded in the UTF-8 charset.

FAQs

1. How can I check DLT guidelines for sending commercial SMS?
Ans: For information on TRAI regulations and DLT registration, refer to TRAI Regulations on Commercial Communications (DLT portal) - SMS in India.

2. What is an SMS template, and how to get it approved?
Ans: To know more about SMS templates, refer to What is an SMS template and how can I get a template approved?

3. How do I check Exotel Account settings?
Ans: To check Exotel Account Settings, refer to How to choose an SMS sender ID?

4. How to choose an SMS Sender ID, and what is its significance?
Ans: To understand this, refer to How to choose an SMS sender ID?

5. How to check the delivery status of SMS sent by me?
Ans: To know more about delivery status, refer to How do I find the delivery status of the SMS I sent using Exotel API?

6. We are seeing an Exotel API error under Campaign. What is the error about?
Ans: Exotel API Error is raised under two circumstances. Firstly, when we try to send a message to Exotel, they do not accept it due to some error. Secondly, when Exotel replies with the error code to CleverTap. For more information on this, refer to Error Codes.

Updated 9 days ago