Kaleyra Whatsapp with LeadSquared

This page covers the following topics:

Pre-Requisites

  • An existing account with Kaleyra. Or you can register for a new one at www.kaleyra.io
  • A valid Facebook business account that has approved WhatsApp numbers and templates associated with Kaleyra as the BSP.
  • Generate an API key and SID in your Kaleyra account. Refer to [Generating an API Key and Security Identifier] for more information.

Installation

To integrate Kaleyra Whatsapp on LeadSquared, perform the following:

  1. Login to your LeadSquared application and head to the Apps Marketplace.
  2. Search with the keyword WhatsApp Messaging Connector.
  1. Click INSTALL on the WhatsApp Messaging Connector plugin as shown below.

Configuration

To configure Kaleyra WhatsApp with LeadSquared, perform the following steps:

  1. Once installed, hover your cursor over the Settings icon and then click Configure. The Configure WhatsApp Business page appears.

Under the Authentication section, enter the below parameters:

Base URL - Enter the Base URL in the text box.
Example: https://api.kaleyra.io/v1/<SID>/messages

  • Use the SID from the key generated on Kaleyra.io.

WhatsApp Number - Enter your WhatsApp Business Number.

  • Ensure you have the WhatsApp Number approved by Facebook.

API Key - Enter the alphanumeric key in the text box.

Kaleyra Inbound Webhook - The Webhook URL is disabled by default.

  • Copy the ‘Kaleyra Inbound Webhook’ parameter.
  • Go to Kaleyra.io and then click Channels.
  • On the Whatsapp page, click Manage and then click Configurations tab.
  • Under the Numbers tab, select the number you want to edit and then click the Edit icon.
    Paste the parameter under the Incoming URL field.
  1. Click Next. The Configure WhatsApp Business page with Field Mapping section appears.

Under the Field Mapping section, enter the below fields:

Activity Mapping - Select the Activity Mapping from the drop-down list. The user needs to select the Whatsapp Message Option.
WhatsApp Opt-Out - Select the WhatsApp Opt-Out from the drop-down list. The options available are Do Not Track, Do Not Call, and Do Not Email.
Default WhatsApp Number Fields - Select the Default WhatsApp Number Fields from the drop-down list. The options available are Phone Number and Mobile Number.
Default Country Code - Enter Default Country Code in format + Country Code i.e. +91.

  1. Click Save. The "Configuration saved successfully" message appears.

Send WhatsApp Messages to one or more Leads

To send a WhatsApp to a lead, perform the following steps:

  1. From the LEADS drop-down list, click Manage Leads. The Manage Leads page appears.
  1. From the Manage Leads page, select one or more leads you want to send the WhatsApp to.
  2. Hover your cursor over the Settings icon, hover over Messaging, and then click WhatsApp. The Send WhatsApp Message page appears.
  1. On the Send WhatsApp Message page, you will find the Service Window. While using this window, you should remember the following:
  • You cannot edit the template message on the Send WhatsApp Message page.
  • If a lead replies to your message for the first time, then Inactive will change to Active for 24-hours.
  • During this 24-hour window, you can send session messages along with template messages.
  • The Service Window will get reset every time the lead replies to a message.
  1. On the Send WhatsApp Message page, select a template from the drop-down list and click Send.

  2. The Successfully sent the WhatsApp message appears as shown below.

Send WhatsApp Messages to Lists

To send a WhatsApp to a list, perform the following steps:

  1. From the LEADS drop-down list click Manage Lists. The Manage Lists page appears.
  1. From the Manage Lists page, select the desired row you want to send the WhatsApp message to.
  2. Under the Actions column, hover your cursor over the Settings icon hover over Messaging, then click WhatsApp. The Send WhatsApp Message page appears.
  1. On the Send WhatsApp Message page, select a template from the drop-down list, then click Send as shown below.

📘

Note:

Unapproved templates won’t be visible while selecting templates. Only approved templates will be available in the template list.

Add, Edit and Delete WhatsApp Templates

Whatsapp templates must be submitted for Facebook approval from your Kaleyra user account. The templates need to be reviewed by WhatsApp to ensure that they do not violate any of their policies.

Once your templates are approved, you can add them to your LeadSquared account.

To add a WhatsApp template, perform the following steps:

  1. From the APPS drop-down list, click WhatsApp Templates. The Manage WhatsApp Templates page appears.
  1. On the Manage WhatsApp Templates page, click Add Template. The Add/Modify Template page appears.
  1. Enter the Name, Namespace, and Content of your message template.
  2. On the Add/Modify Template page. Toggle the slider against Attachments. The Image, video, and Document file option is enabled.
  3. To attach an image, click Image. Format supported is image/jpeg, image/png, and the size is 5 MB.
  4. To attach a Video file, click Video. Format supported is video/mp4, video/3gpp, and the size is 16 MB.
  5. To attach a document file, click Document. Format supported is video/mp4, video/3gpp, and the size is 16 MB.
  6. Image Details (Default Value) - You can insert the file into the template by entering the file URL in the Image Details field. Alternatively, you can attach the file from your desktop by clicking the attachment icon to upload it.
  7. Video Details (Default Value) - Click the attachment icon and choose a video/mp4 file to specify a URL or upload an attachment.
  8. Document Details (Default Value) – Click the attachment icon and choose a file to specify a URL or upload an attachment. If the field you specify is null (if there is no URL contained in the specified field), this attachment will be sent in the WhatsApp message.
  9. Select Attachment Type from the radio button. The options available are Static and Dynamic.
  • Static - Select Static radio button.
  • Dynamic - Select the Dynamic radio button and enter the following details:
    Default file name (applicable only to document type template) – Enter the default file name of the attachment.
    Object – Select the object from the drop-down list. The options available are Lead and Activity.
    Field – Select the field from the drop-down list.
  1. Click Save to save the file as shown below.
  1. Click Cancel to cancel the application and return to the Manage WhatsApp Templates page.
  2. Use the action buttons to Edit or Delete an existing template.
  1. Click Cancel to cancel the application and return to the Manage WhatsApp Templates page.
  2. Use the action buttons to Edit or Delete existing templates.

Updated about a month ago



Kaleyra Whatsapp with LeadSquared


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.