Regulation Impact

Overview

The Telecom Regulatory Authority of India (TRAI) requires distributed ledger technology (DLT) registration for all the service providers for bulk SMS services in India. Starting on February 1, 2021, it is mandatory to send messages to customers via a pre-approved template. For more information regarding DLT registration, refer to SMS Regulations.

What This Means to Our Clients

This requires the following changes from your side when you create an SMS campaign on the CleverTap dashboard.

Template IDs

For the SMS campaigns targeted to Indian mobile numbers and having MSG-91 as the service provider, a template ID always needs to be added. For other service providers, a template ID may or may not be required. We recommend checking with your service provider.

Future Campaigns

Future campaigns are the campaigns that have started after February 1, 2021.

When you create campaigns after the mandated date, you must use a pre-approved template. In the campaign setup where you choose a service provider, we now provide an extra field to provide a template ID.

This field is optional because it is only required for sending SMS messages to phone numbers in India. Check that you provide a matching template ID every time you create an SMS campaign for customers in India.

For generic service providers, you can edit the settings to additionally set up a key-value pair as shown below:

  • Key: This indicates the name of the key for a template ID your service provider is expecting you to send. In the example shown below 'content_id' is the name of the key expected by the service provider.
  • Value: Specify $$TemplateId. You can enter the value of the template ID at the time of the campaign creation.

For example, if the key name for a template ID is expected as content_id.

Current Campaigns

Current campaigns are the campaigns that were started before February 1, 2021. You can provide us template IDs for all your campaigns from your SMS service provider and we will update them for you.

Campaigns

To receive all your running campaigns, perform the following steps:

  1. From the dashboard, navigate to Campaigns.
  2. Select the channel as SMS, then click Apply.
  1. Select the status as Running, then click Apply.
  1. Click on the Subscribe to Reports link.
  1. Once the Campaign Summary Emails window displays, enter a report name.
  2. Select Campaign overview.
  3. Click Send Report.

You will then receive a report via email with all the running SMS campaigns and their relevant campaign IDs.

Journeys

To receive all your running journeys, perform the following steps:

  1. From the dashboard, navigate to Journeys.
  2. Select the status as Running, then click Apply.
  1. Click on the Email report link.
  1. Once the Email report window displays, enter a report name.
  2. Select Nodewise for the report type.
  3. Click Email report.

You will then receive a report via email that you can filter by campaign channel as SMS to get a list of all SMS campaigns with their campaign IDs.

Match IDs

After you have a list of all campaign IDs from the campaign and journey steps above, perform the following steps:

  1. Match these IDs to the template IDs from the SMS service provider's dashboard.
  2. Send this data to the CleverTap platform in the JSON format/JSON payload and hit our endpoint.

Base URLs

Use the appropriate URL depending on your location:

HTTP POST Method

The X-CleverTap-Account-Id and X-CleverTap-Passcode are used to authenticate the request. Please refer to the authentication guide to view how to get their values.

The following headers are all required:

Header
Description
Type
Example Value

X-CleverTap-Account-Id

Your CleverTap account ID.

String

"X-CleverTap-Account-Id: ACCOUNT_ID"

X-CleverTap-Passcode

Your CleverTap account passcode.

String

"X-CleverTap-Passcode: PASSCODE"

Content-Type

Request content-type is always set to application/JSON.

String

"Content-Type: application/json"

The following is a sample JSON:

[
{
"campaign_id" : 1563478922,  // campaign ID
"template_id" : "455633413", // template ID
},
{
"campaign_id" : 1563478922,  
"template _id" : "455633413"
}
]

Your CleverTap campaigns will now have the correct template IDs tagged to them.

Updated 6 months ago


Regulation Impact


Suggested Edits are limited on API Reference Pages

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