Kaleyra

Introduction 

Kaleyra is the API-based platform to engage your clients with personalized messages, chatbots, programmable voice services, and more.

info

Information

  1. 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.
  2. We've revamped our dashboard settings. This article describes the steps to be followed to configure Kaleyra as an Integrated and Custom Connector (Service Provider) in the revamped settings UI and the older UI.
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 in Revamped UI

Configure as a Service Provider (Integrated)

Log in to the MoEngage Dashboard and follow these steps:

  1. Navigate to Settings -> Channel -> SMS -> Sender Configuration.
  2. Click +Add Service Provider at the top right corner.
  3. Select Kaleyra in the Add Sender screen.
  4. 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 Sender. Type the name of the sender here.

    Sender type

    The Sender type can either be one of the following:

    1. Transactional
    2. 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.

  5. Send a test SMS to verify your configuration.
  6. Click Save to save the Sender Configuration.
  7. 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.

Kaleyra_ISP_NewUI.png

Configure as a Custom Service Provider

  1. Navigate to Settings -> Channel -> SMS -> Sender Configuration.
  2. Click +Add custom service provider at the top right corner.
  3. 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.

  4. 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://yr8qyp.api.infobip.com/sms/2/text/advanced

    Method

    Select GET as the HTTP method.

    URL Parameters

    The URL Parameters will be populated from the API URL.

        1. 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.
        2. Replace YourSenderId with the sender ID of your account provided by your service provider.
        3. Add the following values in the to and message fields:
              1. "to" Number to Moesms_destination
              2. "message" to Moesms_message
  5. Send a test SMS to verify your configuration.
  6. Click Save to save the Sender Configuration.
  7. 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.
  8. You can map the attributes of the delivery tracking response manually or automatically.

Configure in Old UI

Configure as SMS Connector (Service Provider) 

IntegratedConnectors.png

  1. On the MoEngage Dashboard, navigate to Settings > Channel > SMS & Connector and click the SMS Connector Config tab.
  2. In Integrated Connectors, click Kaleyra.
  3. Fill in the following details:
    Field Description
    Sender Type Select either Transactional or Promotional to define the type of SMS sent.

    Sender Name

    Type the name to identify the Kaleyra sender.

    Sender ID

    Type the sender ID identifying Kaleyra as the SMS provider.

    warning

    Warning

    • 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.

     

    API Secret

    Type the API secret used to authenticate the Kaleyra account.
  4. In the Is Default Sender, select Yes to make this Kaleyra sender the default SMS Sender.
  5. 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. 
  6. Click Save to save the Kaleyra settings.

Delivery Callback (SMS Connector/Service Provider)

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. 

Configure as a Custom Connector (Service Provider)

Go to Settings>> SMS & Connector >> SMS Connector Config. On this page, click "Create" corresponding to Custom Connectors CreateOption.png 

SMSConnectorSettings.png

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.

GET Method:

Webhook_URL.png

Once you enter your API Request URL, you will be able to see the URL parameters here:

URL_Params.png

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
    For example:

ToNumber.png

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. 

Next Steps

Previous

Next

Was this article helpful?
1 out of 3 found this helpful

How can we improve this article?