Introduction
Kaleyra is the API-based platform to engage your clients with personalized messages, chatbots, programmable voice services, and more.
info |
Information Use this setup to set Kaleyra as an integrated SMS Provider if you plan to send SMS in India via Kaleyra. Configure Kaleyra as a Custom Connector (Service Provider) for other regions. |
library_add_check |
Prerequisites Ensure that you have the login credentials: 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 a Service Provider (Integrated)
To configure Kaleyra as an Integrated Service Provider, log in to the MoEngage Dashboard and follow these steps:
- Navigate to Settings > Channel > SMS > Sender configuration.
- Click +Add Service Provider at the top right corner.
- Select Kaleyra in the Add Sender screen.
- Add the following details in the Sender Details screen.
Field Description Mark as default
This toggle will be disabled during sender creation. The first sender to be created in your MoEngage account will be marked as the default sender for your SMS campaigns. You can change the default sender by following the steps mentioned in Marking a sender as default.
Sender name
This field identifies the readable sender name that can be used while creating a campaign or alert.
Sender type
The Sender type can either be one of the following:
- Transactional
- Promotional
Select the appropriate sender type.
Sender ID
This is the number from which SMS will be sent to your users.
API secret
This is the secret key to authenticate API requests to your Kaleyra account.
- Send a test SMS to verify your configuration.
- Click Save to save the Sender Configuration.
-
Delivery Callback - Delivery receipts will be automatically tracked by MoEngage. MoEngage passes the delivery callback URL in the API call to Kaleyra. You don't have to do any additional configuration for tracking the SMS delivery when using Kaleyra as an integrated service provider.
Configure as a Custom Service Provider
- Navigate to Settings > Channel > SMS > Sender configuration.
- Click +Add custom service provider at the top right corner.
- Add the following details in the Sender Details screen.
Field Description Mark as default
Turn on this toggle to mark the sender as the default sender for the service provider being configured. If marked as default, this sender would be used for sending all SMS campaigns from MoEngage unless you select a different sender while creating the campaign.
Service provider name This field identifies the service provider you are configuring on the MoEngage Dashboard and has to be unique. Type the name of the service provider here.
Sender name
This field identifies the Sender. Type the name of the sender here.
Sender type
The Sender type can either be Promotional or Transactional. Choose the Sender type as Promotional when you would be using the Sender for sending information about your brand, promoting deals, or engaging with users. Choose the Sender type as Transactional when you would be using the Sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.
- Configure the Webhook by adding the following details:
Field Description API URL
This field contains information about the URL that should be used to send an API request to the Sender. You can get this information from the API Documentation of the Sender. Type the API Endpoint of the sender here. The API URL for Kaleyra is:
https://moengage-sms-api.kaleyra.io/send-smsSID
This field contains the Sender ID for Kaleyra.
Kaleyra Host
Kaleyra Host URL: https://api.in.kaleyra.io/
Method
Select GET as the HTTP method.
URL Parameters
The URL Parameters will be populated from the API URL.
-
-
- Replace YourApiKey with the API key provided by Kaleyra. In the to field, you can invoke the personalization editor by typing using @. In the editor, you can select the user attribute that stores the user's mobile number. Ensure that the selected attribute consists of mobile numbers.
- Replace YourSenderId with the sender ID of your account provided by your service provider.
- Add the following values in the to and message fields:
-
-
- "to" Number to Moesms_destination
- "message" to Moesms_message
-
-
-
-
- Send a test SMS to verify your configuration.
- Click Save to save the Sender Configuration.
- You can configure delivery tracking after creating the sender in the MoEngage Dashboard. For information about Delivery Tracking, refer to Delivery Tracking for Custom Connectors.
- You can map the attributes of the delivery tracking response manually or automatically.
Next Steps
- Create an SMS campaign using the Getting Started for creating SMS campaign.
- Set the Frequency Capping for SMS.
- Set the Current Service Provider.