CleverTap Integration Documentation

This integration document outlines the steps to integrate CleverTap with the Pingbix SMS provider. Integrating an SMS provider allows you to send SMS messages via CleverTap. Follow the steps below to set up this integration.

Before you begin the integration process, ensure that you have the following:

• CleverTap account with administrative access
• Pingbix SMS account with the necessary API credentials
• Understanding of your SMS provider's callback mechanism and API endpoints

Log in to your CleverTap dashboard and navigate to the "Settings" section.

1. Navigate to Settings > Engage > Channels > SMS
2. Click on the "+ Add Provider" button

You will need to provide the following information:

• Nickname: Enter a unique nickname for Pingbix SMS provider
• Callback URL: For delivery callback data
• Request Type: Select "POST"
• Authentication Type: Choose "No Authentication" to indicate that this integration does not require any authentication

Parameters:

• Key-value pair: Enter the necessary keys and values required for authentication with Pingbix SMS
• JSON Payload: Enter the JSON payload structure needed for sending SMS via Pingbix. If Pingbix supports batching, you can specify the key name and the number of records per batch
• HTTP Endpoint: Enter the API endpoint of the Pingbix SMS provider

Available dynamic replacements:

• $$To: Mandatory - for phone number
• $$Body: Optional - for message body
• $$TemplateID: Optional - for template ID
• $$TemplateVariables: Optional - for template variables
• $$CampaignID: Optional - for campaign ID
• $$MessageID: For DLR tracking

SMS callbacks help track detailed reports of every SMS sent from the CleverTap dashboard.