Kaleyra is the API-based platform to engage your clients with personalized messages, chatbots, programmable voice services, and more.
Use this setup to set Kaleyra as an integrated SMS provider if you plan to send SMS in India via Kaleyra. For other regions, configure Kaleyra as a Custom connector.
Ensure that you have the login credentials that is the API secret for the SMS Kaleyra Account.
If you have any issues with the credentials or if you do not have the credentials, contact Kaleyra support.
Configure as SMS connector
- On the MoEngage Dashboard, navigate to Settings > Channel > SMS & Connector and click the SMS Connector Config tab.
- In Integrated Connectors, click Kaleyra.
- Fill in the following details:
Field Description Sender Type Select either Transactional or Promotional to define the type of SMS sent.
Type the name to identify the Kaleyra sender.
Type the sender ID identifying Kaleyra as the SMS provider.
- In the Sender ID field, ensure that you add the Header ID approved under the DLT platform. More details on DLT are captured here.
- If you try to send an SMS via an unregistered header, your SMS will be rejected and will not be delivered to the end users.
Type the API secret used to authenticate the Kaleyra account.
- In the Is Default Sender, select Yes to make this Kaleyra sender the default SMS Sender.
- Send a quick test SMS to ensure your configurations are working fine. To do this, click on the Send SMS to Test button. Add:
- Mobile number with country code. Make sure that your account is eligible to send SMS in that particular country
- Add the test message. If you send SMS in India, ensure the message content is in-line with the approved DLT template. More details are captured here.
- If you try to test a Promotional SMS and the test number has DND activated, the message might not be delivered. In such cases, test with a number not in the DND list.
- Click Save to save the Kaleyra settings.
Delivery Callback (SMS connector)
Delivery receipts will be automatically tracked by MoEngage. We pass the delivery callback URL in the API call to Kaleyra. You don't have to do any additional configuration for tracking the SMS delivery via Kaleyra.
Please note that the delivery tracking will not be available for Promotional SMS, as per the new DLT regulations.
Configure as custom connector
Go to Settings>> SMS & Connector >> SMS Connector Config. On this page, click "Create" corresponding to Custom Connectors
Step 1: Set the Connector
Set a name for the Connector and corresponding Sender. You can create multiple Senders corresponding to a Connector or SMS provider. For more information on creating multiple senders, refer to this page.
Step 2: Configure Web-hook
Configure Web-hook URL as shown in the image below.
Once you enter your API Request URL, you will be able to see the URL parameters here:
Replace YourApiKey with the API key provided by Kaleyra. In to field, you can personalize [using @] it to select user's mobile number. Ensure that the selected attribute consists of user's mobile numbers.
Replace YourSenderId with the sender Id of your account provided by your service provider.
Change the value of the following fields:
- "to" Number to Moesms_destination
- "message" to Moesms_message
Step 3: Test and save the settings
Do a test SMS to make sure everything is set up correctly. And finally, click Save to save the settings.
Now you are good to proceed with SMS Campaign creation.
MoEngage cannot track SMS delivery for Custom Connector.
- Create an SMS campaign using the Getting Started for creating SMS campaign.
- Set the Frequency Capping for SMS.
- Set the Current Service Provider.