Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Note: Your external system's configuration will vary depending on the platform. Refer to your system's documentation for specific instructions on how to set up webhook integration.
Copy the following within the Truecaller for Business Console's webhook setup page.
Webhook Endpoint URL:
This is the address (URL) where you will push your segment and template parameters to.
Action: Copy this URL and paste it into the webhook configuration section of your external CX system.
Organization ID:
This is a unique identifier assigned to your organization within the Truecaller for Business system. It's a 16 digit UUID.
Action: Copy this ID. You'll need to include it in the authentication headers of your webhook requests to verify that you're authorized to receive the notifications.
Key-Value Pair Format : X-Org-ID: [Your Organization ID]
Webhook Token:
This token is used for authenticating your webhook requests to ensure secure communication between your system and Truecaller's backend service.
Action: Copy the webhook token and include it in the headers of your requests as an additional security measure.
Key-Value Pair Format: X-Org-Token: [Your Webhook Token]
Discover how to leverage our powerful webhook integrations to enhance your campaign visibility and engagement right from your CEP platform.
Our user-friendly documentation equips you with all the necessary information to seamlessly set up and utilise Truecaller as an additional channel via webhook based connectors from your CEP platform, ensuring you maximize the impact of your Verified Campaigns.
Pre-requisites for using Verified Campaign :
An active Truecaller for Business Verified Business subscription for your business
Integration Steps :
Log into your Truecaller for Business account.
Configure a webhook token for your organisation.
Copy the relevant details from your account - Webhook Endpoint URL, Organisation ID and Token.
Set up "Truecaller" as a new channel of communication on your Customer Engagement Platform, in-house audience definition tool or CRM platform.
Define specific template parameters to personalise the message to be shown to your target users (Refer to Template Styles for Parameter definitions).
That's it! You have now set up a webhook connector to send the audience data to Truecaller for Business backend service.
Verified Campaign will start showing up on Truecaller user device's based on specified parameters and when a Verified Business call or message lands on their device.
Template Generator is a DIY tool within the Truecaller for Business console that allows marketers to craft their marketing templates and generate a JSON payload for seamless integration with your external systems.
Navigate to the "Verified Campaign" section within your business console and click on "Template Generator" option
Step 1: Campaign identifiers and use case
Campaign Name: Enter the name of your Verified Campaign.
Campaign ID: Enter your campaign's unique identifier, this could be the same external campaign reference or campaign ID that you use in your external system
Campaign Type: Select the relevant type (Lifecycle or Offer).
Step 2: Choose your Display Unit
Select the display unit(s) where your campaign will run:
Caller ID: The message shown when a call is received.
ACS (Answered): The message displayed after a call is answered.
ACS (Missed): The message shown after a missed call.
Message ID: The message shown for transactional message notifications
Each display unit may have different template style options available.
Step 3: Configure PDU template
For each selected Display Unit the parameters of customization are different.
Custom Fields: Enter your message content (title, subtitle, CTA, deeplink, etc.) based on the chosen display unit.
Brand Assets:
Text Colors: Choose a text color that works best with your brand image (Black or White).
Template Theme: Select a brand color for the template theme.
Brand Image: Past the image URL for your marketing (Note : Adhere to recommended dimensions and image storage requirements).
Visual Preview: Review the real-time preview of your message as you make changes.
Error Feedback: Address any error messages that appear regarding missing or incorrect fields.
Save and Generate JSON: Click this button when you're satisfied with your template.
Step 4: JSON Generator
JSON Payload: A formatted JSON payload, based on your template and selections, will be displayed. This payload adheres to the required format for Truecaller's Verified Campaign Webhook endpoint.
Copy: Click the "Copy" button to copy the JSON payload to your clipboard.
Important Notes:
Template Styles: Each display unit may offer different template styles (Plain Text with CTA, Image with CTA, Personalized Content with CTA - image on left/right). Experiment to find the best fit for your campaign.
Image Dimensions: Be sure to follow Truecaller's recommended image dimensions for optimal display and outcomes.
Third-Party Integration: Refer to your external system's documentation to understand how to integrate the generated JSON payload correctly.
Truecaller for Business uses webhook tokens to authenticate your webhook connectors. You can easily manage your webhook tokens within the Truecaller for Business console.
By utilizing webhook tokens, you can ensure that your integrations remain secure while connecting your Customer Engagement Platform (CEP) with Truecaller for Business. To set up your webhook token, follow these steps:
Access webhook setup: Navigate to the “Webhook Setup” section within the Verified Campaign tab of the Truecaller for Business console.
Generate token: Click on the “Generate Webhook Token” button to create your token.
Secure your token: Once generated, ensure to copy and store your webhook token securely, as this token will be essential for authenticating your webhook requests. Carefully copy the entire webhook token. This is a sensitive piece of information, so treat it like a password.
Welcome to the Webhook Documentation for Verified Campaign! Get all information about setting up Verified Campaign in this section.
Know more about setting up webhooks for various Customer Engagement Platforms. In case your Customer Engagement Platform is not listed below, you can reach out to your CEP provider to understand webhook creation for the platform used by your business.
CleverTap :
WebEngage :
Segment by Twilio :
Details | Template 1 - Text only | Template 2 - Image only | Template 3 - Personalised content with image on left | Template 4 - Personalised content with image on right |
---|---|---|---|---|
Display your campaign on a sticky pop-up that shows up for Truecaller users when the user misses or rejects your call. Leverage this touchpoint to communicate with your customers with a custom campaign when they fail to receive your call.
To create the JSON payload structure needed for your webhook connectors, use the DIY Template Generator tool within the Verified Campaign tab on the self-serve platform. The tool helps you to create the appropriate template in two simple steps.
Below are the required payload parameters for each Template Style on the Missed Call screen :
profile section parameters are Mandatory for all webhook payloads :
campaign_name : External campaign name reference
campaign_id : External campaign reference ID
campaign_type : Use-case of the campaign, could be either lifecycle or offer
receiver_number : Phone numbers of the end user to whom the communication should be delivered.
content section parameters can vary based on display_unit and template_style as follows : * means mandatory
Details | Template 1 - Text only | Template 2 - Image only | Template 3 - Personalised content with image on left | Template 4 - Personalised content with image on right |
---|---|---|---|---|
Note: Regenerating a webhook token invalidates the previous token immediately. This means any systems or applications using the old token will no longer be able to authenticate with Truecaller's webhook service. Ensure you promptly update all relevant configurations with the new token to avoid service interruptions.
If you suspect your webhook token has been compromised, you can easily regenerate a new token within the business console.
Navigate to webhook setup:
Return to the "Webhook Setup" page within the Verified Campaign section of the business console.
Regenerate token:
Look for a button labeled "Regenerate Webhook Token" on the page below your webhook token section. Click on it to initiate the regeneration process.
Copy and update:
A new webhook token will be generated and displayed on the screen.
Securely copy this new token and update the configuration of any applications or systems that were using the previous token.
PDU Aspect Ratio
320x140
320x140
320x140
320x140
Title
40 characters MAX; supports 2 lines
NA
40 characters MAX; supports 2 lines
40 characters MAX; supports 2 lines
Sub Title
60 characters MAX; supports 2 lines
NA
60 characters MAX; supports 2 lines
60 characters MAX; supports 2 lines
CTA
NA
NA
NA
NA
Image Dimensions
NA
W 320 x H 140
W 100x H 140
W 100x W 140
Image File Format
NA
.jpeg, .png and .gif supported
.jpeg, .png and .gif supported
.jpeg, .png and .gif supported
Image File Size
NA
>2 MB
>2 MB
>2 MB
Redirection
None
None
None
None
Image File Hosting
NA
CDN bucket
CDN bucket
CDN bucket
Local Lannguage Support
Yes
Yes
Yes
Yes
Template 1 - Plain Text with CTA
Template 2 - Image Banner with CTA
Template 3 - Personalised text with CTA (Brand Image on left)
Template 4 - Personalised text with CTA (Brand image on right
"template_style"*
"template_style"*
"template_style"*
"template_style"*
“display_unit”*
“display_unit”*
“display_unit”*
“display_unit”*
"ttl"
"ttl"
"ttl"
"ttl"
"theme_color"*
"image_url"*
"theme_color"*
"theme_color"*
"text_color"*
"deeplink"*
"text_color"*
"text_color"*
"title"*
"title"*
"title"*
"sub_title"*
"sub_title"*
"sub_title"*
"call_to_action"*
"call_to_action"*
"call_to_action"*
"deeplink"*
"image_url"*
"image_url"*
"deeplink"*
"deeplink"*
PDU Aspect Ratio
320x100
320x100
320x100
320x100
Title
40 characters MAX; supports 2 lines
NA
40 characters MAX; supports 2 lines
40 characters MAX; supports 2 lines
Sub Title
NA
NA
NA
NA
CTA
15 characters MAX; supports 1 line
NA
15 characters MAX; supports 1 line
15 characters MAX; supports 1 line
Image Dimensions
NA
W 320 x H 100
W 100 x H 100
W 100 x H 100
Image File Format
NA
.jpeg, .png and .gif supported
.jpeg, .png and .gif supported
.jpeg, .png and .gif supported
Image File Size
NA
>2 MB
>2 MB
>2 MB
Redirection
Landing page on mobileweb browser or app deeplink supported
Landing page on mobileweb browser or app deeplink supported
Landing page on mobileweb browser or app deeplink supported
Landing page on mobileweb browser or app deeplink supported
Image File Hosting
NA
CDN bucket
CDN bucket
CDN bucket
Local Lannguage Support
Yes
Yes
Yes
Yes
Setting up Verified Campaign requires you to configure it within your own Customer Engagement Platform (CEP). Here’s how to get started:
Webhook Connector Setup: Use the webhook connector framework to seamlessly connect your CEP tool with Truecaller for Business. This integration will enable you to push campaign details and relevant parameters to Truecaller, ensuring that your campaigns are executed smoothly and securely.
Customise Campaign Parameters: As part of the campaign setup, customize the parameters such as campaign name, campaign ID, and campaign type based on your specific marketing goals.
Verified Business Interaction: Your campaign will render when a call or message is received from a listed verified business number. This ensures that your audience receives relevant and timely information directly related to their interactions with your business.
Details | Template 1 - Text only | Template 2 - Image only | Template 3 - Personalised content with image on left | Template 4 - Personalised content with image on right |
---|---|---|---|---|
Display your campaign when users receive calls from your verified number, ensuring high visibility and engagement. This touchpoint allows you to present important messages directly during incoming calls, enhancing user awareness of your brand
To create the JSON payload structure needed for your webhook connectors, use the DIY Template Generator tool within the Verified Campaign tab on the Truecaller for Business console. The tool helps you to create the appropriate template in two simple steps.
Below are the required payload parameters for each Template Style on the Caller ID screen :
profile section parameters are Mandatory for all webhook payloads :
campaign_name : External campaign name reference
campaign_id : External campaign reference ID
campaign_type : Use-case of the campaign, could be either lifecycle or offer
receiver_number : Phone numbers of the end user to whom the communication should be delivered.
content section parameters can vary based on display_unit and template_style as follows : * means mandatory
Message ID is a sticky notification that comes up for Truecaller users, capturing their attention for every transactional notification they receive. This touchpoint not only ensures timely and relevant messaging but also delivers business outcomes by enhancing user engagement and interaction with your brand.
To create the JSON payload structure needed for your webhook connectors, use the DIY Template Generator tool within the Verified Campaign tab on the Truecaller for Business. The tool helps you to create the appropriate template in two simple steps.
Below are the required payload parameters for each Template Style on the Message ID screen :
profile section parameters are Mandatory for all webhook payloads :
campaign_name : External campaign name reference
campaign_id : External campaign reference ID
campaign_type : Use-case of the campaign, could be either lifecycle or offer
receiver_number : Phone numbers of the end user to whom the communication should be delivered.
content section parameters can vary based on display_unit and template_style as follows : * means mandatory
PDU Aspect Ratio
320x140
320x140
320x140
320x140
Title
40 characters MAX; supports 2 lines
NA
40 characters MAX; supports 2 lines
40 characters MAX; supports 2 lines
Sub Title
60 characters MAX; supports 2 lines
NA
60 characters MAX; supports 2 lines
60 characters MAX; supports 2 lines
CTA
15 characters MAX; supports 1 line
NA
15 characters MAX; supports 1 line
15 characters MAX; supports 1 line
Image Dimensions
NA
W 320 x H 140
W 100 x H 140
W 100 x H 140
Image File Format
NA
.jpeg, .png and .gif supported
.jpeg, .png and .gif supported
.jpeg, .png and .gif supported
Image File Size
NA
>2 MB
>2 MB
>2 MB
Redirection
Landing page on mobileweb browser or app deeplink supported
Landing page on mobileweb browser or app deeplink supported
Landing page on mobileweb browser or app deeplink supported
Landing page on mobileweb browser or app deeplink supported
Image File Hosting
NA
CDN bucket
CDN bucket
CDN bucket
Local Lannguage Support
Yes
Yes
Yes
Yes
Template 1 - Plain Text only
Template 2 - Image Banner only
Template 3 - Personalised Text with image on left
Template 4 - Personalised Text with image on right
"template_style"*
"template_style"*
"template_style"*
"template_style"*
“display_unit”*
“display_unit”*
“display_unit”*
“display_unit”*
"ttl"
"ttl"
"ttl"
"ttl"
"theme_color"*
"image_url"*
"theme_color"*
"theme_color"*
"text_color"*
"text_color"*
"text_color"*
"title"*
"title"*
"title"*
"sub_title"*
"sub_title"*
"sub_title"*
"image_url"*
"image_url"*
Template 1 - Plain Text with CTA
Template 2 - Image Banner with CTA
Template 3 - Personalised Text with image on left
Template 4 - Personalised text with CTA (Brand image on right
"template_style"*
"template_style"*
"template_style"*
"template_style"*
“display_unit”*
“display_unit”*
“display_unit”*
“display_unit”*
"ttl"
"ttl"
"ttl"
"ttl"
"theme_color"*
"image_url"*
"theme_color"*
"theme_color"*
"text_color"*
"deeplink"*
"text_color"*
"text_color"*
"title"*
"title"*
"title"*
"call_to_action"*
"call_to_action"*
"call_to_action"*
"deeplink"*
"image_url"*
"image_url"*
"deeplink"*
"deeplink"*
Display your campaign on a sticky pop-up that shows up for Truecaller users after a call ends on the user's device. Leverage this touchpoint to reinforce your messaging with a highly engaging visual that appears immediately after the conversation, capturing user attention right when it matters.
To create the JSON payload structure needed for your webhook connectors, use the DIY Template Generator tool within the Verified Campaign tab on the Truecaller for Business console. The tool helps you to create the appropriate template and 2 simple steps.
Below are the required payload parameters for each Template Style on the Universal ACS screen :
profile section parameters are Mandatory for all webhook payloads :
campaign_name : External campaign name reference
campaign_id : External campaign reference ID
campaign_type : Use-case of the campaign, could be either lifecycle or offer
receiver_number : Phone numbers of the end user to whom the communication should be delivered.
content section parameters can vary based on display_unit and template_style as follows : * means mandatory
Template 1 - Plain Text with CTA
Template 2 - Image Banner with CTA
Template 3 - Personalised text with CTA (Brand Image on left)
Template 4 - Personalised text with CTA (Brand image on right
"template_style"*
"template_style"*
"template_style"*
"template_style"*
“display_unit”*
“display_unit”*
“display_unit”*
“display_unit”*
"ttl"
"ttl"
"ttl"
"ttl"
"theme_color"*
"image_url"*
"theme_color"*
"theme_color"*
"text_color"*
"deeplink"*
"text_color"*
"text_color"*
"title"*
"title"*
"title"*
"sub_title"*
"sub_title"*
"sub_title"*
"call_to_action"*
"call_to_action"*
"call_to_action"*
"deeplink"*
"image_url"*
"image_url"*
"deeplink"*
"deeplink"*