Overview

Sinch is a global cloud communications provider that helps businesses to deliver SMS, voice, and other communication services across global markets. By integrating Sinch with CleverTap, you can send transactional and promotional SMS messages through CleverTap’s unified engagement dashboard.

This integration supports message delivery, tracking via DLR (Delivery Receipt), and DLT compliance for enterprises in India.

Here’s how businesses use Sinch with CleverTap:

• Send OTPs and Alerts: Deliver real-time authentication and transaction confirmations.
• Promote Offers and Sales: Target user segments with promotional SMS blasts.
• Re-engage Drop-Offs: Remind users to complete transactions or renew subscriptions.

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

Prerequisites for Integration

To integrate Sinch with CleverTap, ensure the following:

• You must have an active SMS account with Sinch (including username, password, and endpoint), provided by Sinch India support.
• You must have a CleverTap account with SMS setup enabled.
• If your account is registered in India, ensure all templates and headers are DLT-approved.

🚧

Support for Integration

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

Integrate Sinch with CleverTap

To integrate Sinch SMS with CleverTap, follow these three steps:

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

Sinch API for Integration

CleverTap sends HTTPS POST requests to the Sinch API to initiate SMS delivery. The payload must follow the format below to ensure successful delivery and DLT compliance.

• API Endpoint: https://ap.awsigateway.com/v1/enterprises/messages.json
• Sample Request Payload:

{
  "appid": "clvrtap",
  "userId": "clvrtap",
  "pass": "clvrtap_18",
  "contenttype": "1",
  "from": "ACLALT",
  "to": "$$To",
  "selfid": "false",
  "msgid": "$$MessageID",
  "intflag": "false",
  "alert": "1",
  "text": "$$Body",
  "dpi": "1701158123540939524",
  "dtm": "$$TemplateID"
}

This payload includes the recipient details, message content, and DLT information. CleverTap dynamically replaces variables like $$To, $$Body, and $$TemplateID at runtime.

Set Up CleverTap Dashboard

Set up the CleverTap dashboard to connect and authenticate your Sinch 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:

Sample Payload Structure (JSON):

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

{
  "appid": "clvrtap",
  "userId": "clvrtap",
  "pass": "secure_password",
  "contenttype": "1",
  "from": "ACLALT",
  "to": "$$To",
  "selfid": "false",
  "msgid": "$$MessageID",
  "intflag": "false",
  "alert": "1",
  "text": "$$Body",
  "dpi": "1701158123540939524",
  "dtm": "$$TemplateID"
}

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

System Dynamic Replacements

CleverTap replaces the following variables dynamically when sending SMS requests to the provider. These placeholders must be used in the payload or headers, depending on your Sinch configuration:

📘

Note

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

4. Select the Batch option to upload multiple SMS records in one go. Enter the required details for each record.

📘

Single Batch Limit

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

5. 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 Sinch 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 Sinch.

3. Click Send Test.

If the configuration is correct, the test message will be delivered, and Sinch 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 Sinch support 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 Sinch India 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 Sinch 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 ICS Mobile as your SMS provider.