Follow the below steps to configure ICS as your SMS Service Provider (SSP).
As shown above:
Step 1: Select SSP
Select ICS from the List of Available SSPs. In doing so, you will be prompted by a configuration modal.
Step 2: Name your Configuration
Please add a user-friendly name that enables you to identify the right SSP for a campaign while creating it. This comes in handy especially, when you have multiple accounts with the same SSP for sending different types of campaigns.
For example, if you have chosen to use ICS for sending Promotional campaigns, then we recommend that you indicate the same by naming the configuration something like:
- ICS Promo
- ICS Mobile Promo Pipeline
Step 3: Add API Key
Navigate to your ICS dashboard to find your API Key. Paste them in the configuration modal to connect your account with WebEngage.
Step 4: Account Type
From the drop-down, choose whether your account is Promotional, Transactional, or Global.
Step 5: Add Principal Entity ID
(Applicable only if you are sending messages to users located in India via domestic messaging pipeline. International messaging routes remain unaffected.)
As per TRAI's latest SMS Marketing regulations for India, you must be registered on a DLT portal as a business entity. Once registered, a unique Principle Entity ID (PE ID) will be assigned to you.
W.e.f from Nov 19, 2020, it is mandatory for all SSPs to pass a PE ID in the payload of each SMS message being sent to Indian phone numbers. We have partnered with ICS to make this a seamless process for you.
Add your PE ID during configuration - we will ensure that it is relayed to the SSP for each SMS sent to your users.
Step 6: Add Header
For Kaleyra SSP, kindly add custom header with param
Env. The value to be passed is either
US if your WebEngage dashboard is located in the US server or
IN if its located in the India server. This configuration is required for tracking DSN (Delivery Status Notification)
Find your account server location
If you are not sure which server your account is on, kindly check the URL of your dashboard:
For the US server, the URL is
For the Indian server, the URL is
Step 7: Add SSP
Click Add SSP, and you're good to go!
Step 8: Add WebEngage Webhook URL in ICS Dashboard (Highly Recommended)
Adding the WebEngage Webhook in ICS will enable us to receive delivery status notifications for each user. This includes campaign performance indicators like the message delivered, failed, and queued.
Here's how you can go about it:
Step 8.1.: As shown below, you will find your ICS integration under the section, Your SMS Service Provider List.
Step 8.2.: Click the overflow menu placed on the extreme right, click View Webhook URL, and copy the link.
Step 8.3.: Paste the WebEngage Webhook URL under the relevant field in your ICS dashboard and click Save. Please connect with your ICS Account Manager for further assistance.
You've now successfully integrated ICS with your WebEngage dashboard.
You can test the integration by creating a test SMS campaign and sending it to a group of internal users (aka your teammates).
Please feel free to drop in a few lines at [email protected] in you have any further queries. We're always just an email away!
Updated about 1 year ago