Kaleyra
SMS Provider
Overview
Kaleyra is a Communications Platform as a Service (CPaaS) provider that helps businesses send and receive SMS messages across global markets.
By integrating Kaleyra with CleverTap, you can manage SMS campaigns directly from the CleverTap dashboard, alongside other engagement channels. This integration supports message delivery and DLR (Delivery Report) tracking, allowing you to run personalized, targeted SMS campaigns as part of your omnichannel strategy.
Here are a few ways businesses use Kaleyra with CleverTap:
- Transactional Alerts: Deliver real-time OTPs, order confirmations, and payment updates.
- Promotional Campaigns: Announce offers, discounts, or product launches to targeted user segments.
- Abandoned Cart Reminders: Prompt users to complete their purchase with time-sensitive nudges.
Integrate CleverTap’s segmentation engine with Kaleyra SMS to trigger context-aware messages and increase engagement.
Prerequisites for Integration
To integrate ICS with CleverTap, check the following:
- You must have an active Kaleyra account with API access.
- You must obtain the HTTP Endpoint, API Key, SID, and Kaleyra host URL from Kaleyra support.
- You must have a CleverTap account with SMS setup enabled.
- If your account is based in India, ensure your message templates and sender IDs are registered with DLT.
Support for Integration
This integration is managed and continuously improved by Kaleyra. The CleverTap and Kaleyra integration has undergone stringent testing to ensure seamless functionality. For any questions or issues, contact Kaleyra for support and resolution.
Integrate Kaleyra with CleverTap
The integration includes three major steps:
Find Kaleyra API Credentials
To complete the setup, gather the following details from your Kaleyra account or Kaleyra support:
- API Key: Found under API Settings in your Kaleyra Customer Portal. Used in the
api-keyheader. - SID: Sender ID linked to your Kaleyra account. Used in the
sidheader. - API Host Domain: The base URL used to send requests. Set this in the
kaleyra-hostheader.
For more information on locating Kaleyra API credentials, refer to View API Key and SID
Set Up CleverTap Dashboard
Set up the CleverTap dashboard to connect and authenticate your Kaleyra SMS provider. To configure the CleverTap dashboard:
- Go to Settings > Engage > Channels > SMS in the CleverTap dashboard.
- Click + Add Provider. The Add SMS provider page opens.
Add Provider
- Under Provider, select Other (Generic) and enter the following details:
| Field | Description |
|---|---|
| Nickname | Enter the nickname of the SMS provider to identify it uniquely. For example:Kaleyra_SMS |
| Callback URL | Enter this URL in the Kaleyra platform to receive delivery status updates for your SMS messages. Refer to Set Up SMS Callbacks. |
| Request Type | SelectPOST |
| HTTP Endpoint | Paste the URL received from Kaleyra team. Ensure that the URL is in HTTPS format, that is, your URL must begin with https://. |
| Authentication | Under Authentication, select one of the following options: - No Authentication. - Basic Authentication: Enter the username and password. |
- Under Headers, enter the following Key/Value pair.
| Key | Value |
|---|---|
api-key | API Key from Kaleyra |
sid | SID from Kaleyra |
kaleyra-host | API domain from Kaleyra |
callback_url | CleverTap callback URL |
Provider Configuration
- In the Parameters tab, set the Type to
x-www-form-urlencoded. Enter the following as a Key/Value pair: - Under the Parameters tab:
- Set Type to
x-www-form-urlencoded - Add the following key-value pairs:
- Set Type to
| Key | Value | Description | Required |
|---|---|---|---|
to | $$To | Recipient’s phone number | Yes |
sender | $$Sender | Sender ID (dynamic if mapped) | Yes |
body | $$Body | Message content | Yes |
template_id | $$TemplateID | DLT Template ID (mandatory for messages in India) | Optional |
message_id | $$MessageID | Unique CleverTap message ID for tracking | Yes |
campaign_id | $$CampaignID | CleverTap campaign ID | Optional |
type | $$TYPE | Message type (OTP, MKT, TXN, or Default, OTP) | Optional |
long_url | $$LongURL | Long URL to shorten and insert into the message (if supported) | Optional |
Note
$$MessageIDis required for accurate DLR (Delivery Report) tracking. Kaleyra must return the same ID in the delivery callback.
Set Parameters
- Click on Save. A pop-up box will appear, prompting you to Send Test SMS.
Send a Test SMS
Sending a test SMS helps confirm that your Kaleyra integration is working before launching a live campaign. This ensures the API endpoint is correctly configured, authentication is valid, and messages can be delivered.
To validate your configuration:
- Click the Send Test SMS hyperlink before creating SMS campaigns and journeys.
- Enter the following details:
- Country Code and Mobile Number: Enter the country code and mobile number to which you want to send the message.
- Template ID: (if applicable)
- Message: Enter sample text, such as This is a test message powered by Kaleyra.
- Dynamic Fields: If
sender,type, orlong_urlare dynamic, provide those values as key-value pairs
Send a Test SMS
- Click Send Test.
If the configuration is correct, the test message will be delivered, and Kaleyra will return a DLR update. If there is an error (for example, incorrect credentials or endpoint), CleverTap will display a failure notification.
Set Up SMS Callbacks
To track SMS requests, copy the Delivery report callback URL from the CleverTap dashboard and share it with the Kaleyra support team.
- You can find the Delivery report callback URL on the CleverTap dashboard under the Provider Setup page Settings > Channels > SMS > Provider Nickname
- Share this URL with Kaleyra support.
Set Up SMS Callbacks
Verifying Successful Integration
Your integration is considered successful when the following criteria are met:
- The test SMS is delivered to the intended mobile number.
- You receive a DLR (Delivery Report) callback from Kaleyra at the configured CleverTap callback URL, indicating delivery, failure, or queue status.
- CleverTap logs show no errors related to authentication, payload structure, or message transmission.
Once these conditions are met, you can proceed to build and launch SMS campaigns or set up Journeys using Kaleyra as your SMS provider.
Updated 2 days ago