Configure Kaleyra SMS on WebEngage

While you will be using WebEngage to create your SMS campaigns, the delivery of the message to your target audience is facilitated by Kaleyra SMS Service Provider (SSP).

Prerequisite

You must have an active Kaleyra account to use the Kaleyra SMS plugin on the WebEngage platform.
To register a new account on Kaleyra.io, contact our support team.
See: Support

Configure Kaleyra SMS on WebEngage

To configure Kaleyra as your SMS Service Provider (SSP):

1. Log in to WebEngage.
2. On the Data Platform list, click Integrations. The Integration Status page appears.
3. In the Channel Integration Status > SMS Setup section, click Configure.

4. Scroll through the Available SMS Service Providers (SSP) section, and click Kaleyra.

You will be prompted by this Add SSP configuration modal.

5. In the NAME YOUR CONFIGURATION field, enter a configuration name.
6. In the API KEY field, enter the API key associated with your account.
7. From the ACCOUNT TYPE list, select one of the following options:
   1. TRANSACTIONAL
   2. PROMOTIONAL
   3. GLOBAL

📘

Notes:

• If you want to send a variety of messages like Promotional, Transactional, OTP, and so on, use the Account Type - Global.
• The PRINCIPAL ENTITY ID field is relevant, only if you are registered with the Distributed Ledger Technology (DLT) system.

8. Click Add Header. Two text boxes appear.

📘

Note:

You need to enter the parameter and its details in the CUSTOM HEADERS section. For more information about API Key, SID, and API Domain see View API Key and SID.

9. Enter the following parameters information:
   1. sid - As the parameter and the SID associated with your account as the value.
   2. api-key - As the parameter and the API-Key associated details with your account as the value.
   3. kaleyra-host - As the parameter and the API base URL associated details with your account as the value. For example, https://api.kaleyra.io.
   4. country-iso-code - As the parameter and the country code which you want to set as the default value. For example, IT for Italy.

📘

Note:

Once you select the country code, the country code gets added to the entered number (with accurate digits format based on a selected country. For example, +39XXXXXXXXXX for the Italian number and +91XXXXXXXXXX for Indian number) while configuring the campaigns. If you enter a number with a country code, then the default country code will be overridden.

10. Click ADD SSP. The SSP is now listed in the Your SMS Service Provider (SSP) List.
11. Copy the Webhook URL for your SSP profile.

📘

Note:

The existing user can view the Webhook URL from the configured SSP profile, in the Your SMS Service Provider (SSP) List section.

12. Under the Actions column, click the three dots corresponding to the SSP and click View Webhook URL and copy the Webhook URL.

13. Under the Actions column, click the three dots corresponding to the SSP and click Edit. The Edit SSP screen appears.

14. Click Add Header. Two text boxes appear.
15. Enter callbackurl as the parameter and value as the Webhook URL that you had copied.
16. Click Save.

📘

Note

While running a campaign, it is recommended that you request WebEngage to set the throttling limit to less than 3500 messages per minute.

Additional information regarding SMS campaigns

📘

Note:

To know more about creating SMS campaigns using WebEngage refer to Creating SMS Campaigns.

While the SMS campaign is created and personalized through your dashboard, the actual message is delivered by the Kaleyra SSP. Ensure that you have integrated Kaleyra SSP with your account before proceeding, as it enables message delivery to all your users.

While creating the SMS campaign, ensure that you select the Kaleyra SSP that you have configured.