Overview

Route Mobile is a cloud communications platform that provides scalable and secure SMS delivery across global markets. When integrated with CleverTap, it allows businesses to send real-time SMS notifications and promotional messages with advanced tracking and delivery insights.

Here’s how businesses use Route Mobile with CleverTap:

• OTP and Alerts: Send authentication codes, transaction updates, and critical account messages.
• Promotional Campaigns: Reach user segments with marketing offers and time-bound deals.
• Order Notifications: Deliver shipping, order, and service status updates instantly to customers.

Integrate CleverTap’s segmentation and campaign engine with Route Mobile's SMS delivery pipeline for high-engagement, context-driven messaging.

Prerequisites for Integration

To integrate Route Mobile with CleverTap, ensure the following:

• You must have Route Mobile credentials (username, password, sender ID, DLT credentials), provided by the Route Mobile SPOC.
• You must have a CleverTap account with SMS channels enabled.
• If registered in India, your Route Mobile account must be DLT-compliant.

🚧

Support for Integration

This integration is managed and continuously improved by Route Mobile. The CleverTap and Route Mobile integration has undergone stringent testing to ensure seamless functionality. For any questions or issues, contact Route Mobile for support and resolution.

Integrate Route Mobile with CleverTap

To integrate Route Mobile SMS with CleverTap, follow these three steps:

1. Route Mobile API for Integration
2. Set Up CleverTap Dashboard
3. Send a Test SMS

Route Mobile API for Integration

CleverTap sends HTTP(S) requests to Route Mobile's API for SMS delivery. Following are the common endpoints based on the message region:

• Domestic SMS API: Used to send messages to Indian mobile numbers with DLT compliance.

  http://sms6.rmlconnect.net:8080/bulksms/personalizedbulksms?...parameters...
  

• International SMS API: Used for sending messages to numbers outside India.

  https://api.rmlconnect.net/bulksms/bulksms?...parameters...
  

These are the static authentication and sender parameters typically required in the Route Mobile API:

These parameters are set once during configuration and do not change per campaign.

System Dynamic Replacements

CleverTap dynamically replaces the following placeholders during SMS campaign execution to personalize and route each message appropriately:

These dynamic fields must be used in the request URL or payload and will be replaced by CleverTap at send time.

Set Up CleverTap Dashboard

Set up the CleverTap dashboard to connect and authenticate your Route Mobile SMS provider. To configure the CleverTap dashboard:

1. Go to Settings > Engage > Channels > SMS in the CleverTap dashboard.
2. Click + Add Provider. The Add SMS provider page opens.

3. Under Provider, select Other (Generic) and enter the following details:

4. Enter the following details under the Headers section.

5. Under Parameters, select JSON as the request type for the POST request.
   Refer to the following sample payload below for the expected structure.

Sample Payload Structure (JSON):

Use the following sample JSON payload when configuring the Route Mobile provider in CleverTap. The payload represents the structure used to send an SMS message via Route Mobile. Replace placeholder variables with system dynamic replacements such as $$To and $$Body.

{
  "username": "xxxx",
  "password": "xxxx",
  "source": "xxxx",
  "destination": "$$To",
  "message": "$$Body",
  "entityid": "xxxx",
  "tempid": "$$TemplateID",
  "tagname": "$$CampaignID",
  "msgid": "$$MessageID"
}

This structure ensures that message-specific data, such as recipient, sender, content, and a unique message ID are correctly passed to the Route Mobile API.

📘

Note

$$MessageID is required for accurate DLR (Delivery Report) tracking. Route Mobile must return the same ID in the delivery callback.

6. Select the Batch option to upload multiple SMS records. Enter the required details for each record.

📘

Single Batch Limit

A single batch can have a maximum of 1,000 records.

7. Click on Save. A pop-up box will appear, prompting you to Send Test SMS.

Send a Test SMS

Sending a test SMS helps confirm that your Route Mobile integration is working before launching a live campaign. This ensures the API endpoint is correctly configured, authentication is valid, and messages can be delivered.

To validate your configuration:

1. Click the Send Test SMS hyperlink before creating SMS campaigns and journeys.
2. Enter the following details:
   • Country Code and Mobile Number: Enter the country code and mobile number to which you want to send the message.
   • Message: Enter sample text, such as This is a test message powered by Route Mobile.

3. Click Send Test.

🚧

DLT Compliance Requirements for Messaging

• Domestic messages must exactly match DLT templates.
• International messages do not require DLT compliance.

If the configuration is correct, the test message will be delivered, and Route Mobile will return a DLR update. If there is an error (for example, incorrect credentials or endpoint), CleverTap will display a failure notification.

Set Up SMS Callbacks

To track SMS requests, copy the Delivery report callback URL from the CleverTap dashboard and share it with the Route Mobile team.

1. You can find the Delivery report callback URL on the CleverTap dashboard under the Provider Setup page Settings > Channels > SMS > Provider Nickname.
2. Share this URL with Route Mobile Support.

Verifying Successful Integration

Your integration is considered successful when the following criteria are met:

• The test SMS is delivered to the intended mobile number.
• You receive a DLR (Delivery Report) callback from Route Mobile at the configured CleverTap callback URL, indicating delivery, failure, or queue status.
• CleverTap logs show no errors related to authentication, payload structure, or message transmission.

Once these conditions are met, you can proceed to build and launch SMS campaigns or set up Journeys using Route Mobile as your SMS provider.