Only this pageAll pages
Powered by GitBook
1 of 46

Verified Campaigns

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

API/Webhook Documentation

Welcome to the API/Webhook Documentation for Verified Campaigns! Get all the information about setting up Verified Campaigns in this section.

Webhook Connectors
Campaign Payload
Third Party Resources
FAQs
Bulk API

Webhook Connectors

API URLs to be used

Base URL :

Note: The above URL is for API requests only. The corresponding frontend web application URL where you can log in and verify the data is

Webhook Setup

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 Truecaller for Business console's webhook setup page.

  1. Webhook Endpoint URL:

https://enterprise-portal-noneu.truecaller.com
https://business.truecaller.com/signin
Event Types
Webhook Setup
Webhook Token Regeneration

This is the address (URL) where you will push your segment and template parameters to.

  • https://enterprise-webhooks-noneu.truecaller.com/v2/campaigns

  • 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]

  • Getting Started

    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 customer engagement platform, enabling you to maximize the impact of your Verified Campaigns.

    Pre-requisites for using Verified Campaigns :

    • An active subscription of Truecaller Customer Experience Solution for your business

    Integration Steps :

    1. Log into your Truecaller for Business account.

    2. Configure a webhook token for your organization.

    3. Copy the relevant details from your account - Webhook Endpoint URL, Organization ID and Token.

    4. Set up "Truecaller" as a new channel of communication on your Customer Engagement Platform, in-house audience definition tool or CRM platform.

    Webhook Token Regeneration

    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.

    1. Navigate to webhook setup:

    Upload your marketing assets via your Truecaller for Business console.

  • Define specific template parameters to personalize the message to be shown to your target users (Refer to Template Styles to know more about available templates).

  • That's it! You have now set up a webhook connector to send the audience data to Truecaller for Business backend service.

  • Verified Campaigns 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.

  • Bulk API

    This page will guide us on how we can use the Bulk API for Verified Campaigns

    Webhook Events

    To help you stay informed about events related to the features in your enterprise plan, you can easily configure Webhooks (also known as HTTP callbacks) directly on our Self-serve platform. This ensures your systems are automatically notified, keeping you seamlessly updated.

    Should you wish to learn more about how webhooks can benefit your operations, please don't hesitate to contact us at: [email protected]. We'd be happy to assist you!

    Return to the "Webhook Setup" page within the Verified Campaigns 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.

  • Authentication

    This page provides the steps to generate the Key ID and Secret API Key.

    Generate API Keys

    API keys are used to ensure the authenticity of interactions between your application and Truecaller for Business APIs.A maximum of 10 tokens can be created every 30 minutes.

    • Truecaller for Business uses API keys for authenticating API requests.

    • You can view and manage your API keys from the True caller for Business console.

    • Click on “API Setup” from the left-hand rail in the account under "Connectors"

    • Click on the “Create API Key” button.

    • Enter the Key Name and Description (optional). You can see the access level underneath the description box for all available features.

    • Click on “Generate”. This will take you to the screen which has the option to copy/save the Key ID and Secret API Key. This file should be downloaded and kept securely.

    What is Verified Campaigns?

    Verified Campaigns empowers businesses to hyper personalize their customer engagement and power growth through business calls and SMS.

    Core Features :

    • Integtates with existing customer engagement platforms and internal CRMs

    Enables segmentation, personalization and contextualization for engagement on business calls and SMS
  • Supports a vast number of use cases across onboarding, activation, nurturing, advocacy, dormancy and churn.

  • Multiple engaging template styles that can be customized and personalized as needed

  • GIF, .jpeg and .png support for images.

  • Local language support on the PDUs.

    Can I schedule a demo for Verified Campaigns?

    Yes, we can help you with that. Please reach out to us at [email protected] and our team will reach out to you.

    Where can I view all the campaigns run on Truecaller?

    You can view all the campaigns you have run on Truecaller by following these steps:

    1. Log into the Truecaller Business Console: Access your account by logging into the Truecaller Business Console using your organizational credentials.

    2. Navigate to Verified Campaigns: On the left-hand side panel, click on the “Verified Campaigns” tab to access the campaign management section.

    3. View Campaign Listings: Under the “Campaigns” section, you will see a comprehensive list of all your executed campaigns. This list includes details such as:

      • Campaign Name

      • Campaign ID

      • Campaign Type

      • Stats (impressions, clicks, etc mapped to each Campaign)

    Can businesses track the performance of their Verified Campaigns?

    Yes, businesses can track the performance of their Verified Campaigns through a Looker dashboard integrated into the Truecaller for Business console. Metrics such as impressions, clicks, unique users reached, and CTR can be viewed, helping businesses evaluate the effectiveness of their campaigns.

    Navigate to "Analytics" tab to view unified campaign analytics :

    Campaign Payload

    Generate campaign payload using the DIY tool on the business console or follow the documentation.

    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 Campaigns" 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 campaign.

    What all features of Verified Business does Verified Campaigns work with?

    Verified Campaigns seamlessly integrates with several CX features of Verified Business to enhance your communication strategy. Here’s what you can expect:

    Compatible Features:

    When Verified Campaigns is active, the following features will be supported with conditions :

    • Verified Business Caller ID

    • Business Call Reason:

    Third Party Resources

    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 :

    Can businesses view payload exchange metrics?

    Yes, businesses can access detailed payload exchange metrics via the Truecaller for Business console. We provide a breakdown of successfully processed records along with granular reasons for any rejections.

    These are shared asynchronously to ensure clarity and traceability mapped to each unique Campaign ID.

    Here are some common rejection reasons:

    • Receiver’s app version is not supported → Truecaller user is on an unsupported app version

    • Receiver’s OS is not supported → Truecaller user is using an iOS device

    FAQs

    Get answers to all your queries about Verified Campaigns in this section.

    What is the format of the Phone number field to be used in the payload?

    The phone number must be provided as a 12-digit string, which includes the 2-digit country code followed by the 10-digit mobile number (e.g., 91XXXXXXXXXX for India).

    This phone number value can also be then be SHA-256 hashed (in lowercase hex format) before being shared in the payload.

    Example:

    • Raw phone number: 911234567891

    What are the various templates for Verified Campaigns?

    Verified Campaigns includes several templates designed to enhance customer engagement through dynamic and contextually relevant interactions within the Truecaller app.

    Here are the templates for Verified Campaigns :

    • Plain text with CTA.

    • Image banner with CTA.

    • Personalized text with CTA (Image on left).

    Caller ID Screen - Business Call Reason will always take precedence over an active campaign on the Caller ID Screen; the Campaign in this scenario will be shown to the user during the Ongoing Call if they decide to Answer the call

  • Post Call Screen - Both Business Call Reason and Campaigns will be supported together on this touchpoint.

  • Business Profile

  • Overridden Features:

    When Verified Campaigns is active, the following features will be temporarily overridden:

    • Video Caller ID

    • Call Me Back

    • User Feedback

    Receiver is not a Truecaller user → The user is not registered on Truecaller

  • Invalid receiver number → Phone number in the payload is malformed or incorrect

  • Error in SHA-256 encoded format → Phone number was not provided in valid SHA-256 format

  • All system-side errors (such as internal timeouts) are grouped under a unified error bucket labeled → Internal system errors

  • SHA-256 Hash: efc187bdaca8e73ddffb1b4615e9652bb775721335bc97f47888dfebd9058444

    Important Notes:

    • No plus sign (+) should be included before the country code.

    • Ensure the number is exactly 12 digits before hashing.

    • The hashed output must be passed as a string in the payload.

    What is Verified Campaigns?
    How does Verified Campaigns work?
    What are the available touchpoints on Truecaller where I can run Verified Campaigns?

    What tools can Verified Campaigns integrate with?

    Verified Campaigns is designed to be fully platform-agnostic, ensuring seamless integration with your existing marketing and customer engagement stack.

    Whether you use a Customer Engagement Platform (CEP), Customer Data Platform (CDP), CRM, Marketing Automation Tool, or even an in-house solution, Verified Campaigns can effortlessly sync with your workflows.

    We achieve this by supporting a simple webhook-based integration, allowing any system that can push event-driven data to communicate with our platform in real time. This means you can trigger Verified Campaigns based on specific customer actions, behavioral signals, or lifecycle events, ensuring hyper-personalized and timely campaign messaging.

    Some key benefits for marketing teams: ✔ Omnichannel Activation – Extend the reach of your marketing stack by engaging users via Verified Calls & Messages in addition to existing channels. ✔ Real-time Personalization – Leverage first-party data from your CDP/CRM to deliver contextually relevant campaigns. ✔ No Platform Lock-in – Works with any tool of your choice, eliminating dependency on a single vendor. ✔ Scalability and Compliance – Enterprise-grade scalability with built-in data privacy and security measures.

    This flexibility makes Verified Campaigns an essential component of any modern B2B marketing and customer engagement strategy, enabling brands to drive higher reach, conversions, and ROI.

    What are the pre-requisites to sign up for Verified Campaigns?

    To sign up and utilize Verified Campaigns, you must have an active Truecaller Customer Experience Solution subscription.

    This is essential because all Verified Campaigns will be shown to your customer in the Verified Business interfaces only. Verified Campaigns gets triggered on the basis of your calling or messaging events that happen on the Truecaller app.

  • Create Message

  • Personalize Message

  • MoEngage :

    • Authorization Configuration with OAuth 2.0 – User Guide

    • Create a Connector Campaign – User Guide

  • WebEngage :

    • https://docs.webengage.com/docs/webhooks

  • Netcore :

    • https://cedocs.netcorecloud.com/docs/webhook

  • Segment by Twilio :

    • Setup Webhooks

  • Setup Webhooks
  • 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 incoming pop-up shown when a call is incoming on a user device.

      • Post Call Pop-up (Universal): The pop-up displayed after a call is answered., missed or rejected.

      • Missed Call Pop-up : The pop-up shown after a missed call.

      • Sticky Message ID: The UI shown for transactional message notifications

      • Business Profile : The brand page on the Truecaller app/

    • Each display unit may have different template style options available.

    Step 3: Configure Campaign template

    • Dynamic Fields : For each selected Display Unit and Template Style the parameters of customization are different.

      • Custom Fields: Enter the campaign message content (title, subtitle, CTA, deeplink, etc.) based on the chosen display unit and template style chosen.

    • Static Fields : These are stored and saved in our backend mapped to your Campaign ID

      • Text Color: 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: Host your marketing assets on Truecaller Assets page (Note : Adhere to recommended dimensions and image storage requirements).

    • 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 Campaigns 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.

    Personalized text with CTA (Image on right).

    Verified Campaigns Bulk API

    This endpoint pushes the campaign details to the respective TC users.

    Maximum 500 campaigns can be pushed in a single API call

    Replace the {{BaseURL}} with the one mentioned here

    POST {{BaseURL}/organisations/{organisationid}/campaigns/bulk-upload

    {organisationid} : This can be taken directly from the self serve portal under the API Setup Page

    Headers

    Name
    Value

    Body

    In case of single object we can pass it as a raw json and we need not add the request in the file format.

    File in below format -for multiple user records

    Name
    Type
    Validations
    Description

    Response

    Post Call Pop-up

    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 Campaigns 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_id : External campaign reference ID

    • 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 - Text only
    Template 2 - Image Banner only
    Template 3 - Personalised content with image banner on left
    Template 4 - Personalised content with image banner on right

    Caller ID

    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 Campaigns 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_id : External campaign reference ID

    • 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 selected as follows : * means mandatory

    Template 1 - Text only
    Template 2 - Image Banner only
    Template 3 - Personalised content with image banner on left
    Template 4 - Personalised content with image banner on right

    Sticky Message ID

    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 Campaigns 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_id : External campaign reference ID

    • 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 - Text only
    Template 2 - Image Banner only
    Template 3 - Personalised content with image banner on left
    Template 4 - Personalised content with image banner on right

    What are the available touchpoints on Truecaller where I can run Verified Campaigns?

    Verified Campaigns can be configured on the below touchpoints on the Truecaller app :

    Verified Caller ID : 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.

    Post-Call Screen : Drive post call contextualized targeting with a sticky pop-up that shows up for Truecaller users after a call ends. 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. Leverage this touchpoint to engage with your customers with a custom campaign even when they reject or miss your call.

    Verified Message ID : 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.

    Business Profile: Along with letting customers know your business and brand better through your Business Profile, you can now target them with personalized engagement. Engage whenever your customers visit your Business Profile on Truecaller and drive growth on this untapped touchpoint.

    Missed Call Pop-up

    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 Campaigns 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_id : External campaign reference ID

    • 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 - Text only
    Template 2 - Image Banner only
    Template 3 - Personalised content with image banner on left
    Template 4 - Personalised content with image banner on right

    Event Types

    We support Detailed Events (Impressions and Clicks) and Click events via webhooks. Each event has its resources that can be referred from the resource column.

    Clickstream Webhook Event Structure

    Sticky Message ID

    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

    Does Verified Campaigns allow the sharing of Phone Number field in SHA 256 Hashed format?

    Yes, Truecaller supports the use of SHA-256 hashed values for PII fields such as phone numbers. This allows businesses to maintain data privacy and security while still leveraging Truecaller’s Verified Campaigns capabilities

    When using hashed inputs:

    • The phone number must be in 12-digit format (e.g., 91XXXXXXXXXX), without the plus sign.

    • Apply SHA-256 hashing to the 12-digit number.

    Webhook Configuration

    A total of 5 webhooks can be configured under a customer account at a given point in time.

    To configure your webhooks, simply follow these steps:

    1. Access Webhook : Click on Manage Webhooks under Verified Campaigns

    Send the lowercase hexadecimal string in the payload.

    Example:

    • Raw phone number: 911234567891

    • SHA-256 Hash: efc187bdaca8e73ddffb1b4615e9652bb775721335bc97f47888dfebd9058444

    Template 1 - Customisable Text-only
    Template 2 - Image only
    Template 3 - Personalised content with image on Left
    Template 4 - Personalised content with image on Right

    What is the pricing for Verified Campaigns?

    To understand more about the pricing of Verified Campaigns, please reach out to your Truecaller for Business account manager or write to us at [email protected].

    "sub_title"*

    "sub_title"*

    "call_to_action"*

    "call_to_action"*

    "call_to_action"*

    "deeplink"*

    "deeplink"*

    "deeplink"*

    "ttl"

    "ttl"

    "ttl"

    “display_unit”*

    “display_unit”*

    “display_unit”*

    “display_unit”*

    "title"*

    "deeplink"*

    "title"*

    "title"*

    "sub_title"*

    "ttl"

    "sub_title"*

    "sub_title"*

    "ttl"

    "ttl"

    "ttl"

    “display_unit”*

    “display_unit”*

    “display_unit”*

    “display_unit”*

    "title"*

    "ttl"

    "title"*

    "title"*

    "sub_title"*

    "call_to_action"*

    "call_to_action"*

    "deeplink"*

    "deeplink"*

    "deeplink"*

    "ttl"

    "ttl"

    "ttl"

    “display_unit”*

    “display_unit”*

    “display_unit”*

    “display_unit”*

    "title"*

    "deeplink"*

    "title"*

    "title"*

    "call_to_action"*

    "ttl"

    "sub_title"*

    "sub_title"*

    "call_to_action"*

    "call_to_action"*

    "call_to_action"*

    "deeplink"*

    "deeplink"*

    "deeplink"*

    "ttl"

    "ttl"

    "ttl"

    “display_unit”*

    “display_unit”*

    “display_unit”*

    “display_unit”*

    "title"*

    "deeplink"*

    "title"*

    "title"*

    "sub_title"*

    "ttl"

    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

    >150 KB

    >150 KB

    >150 KB

    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

    PDU Aspect Ratio

    320x100

    320x100

    320x100

    320x100

    Title

    40 characters MAX; supports 2 lines

    NA

    contents

    array of object

    min:1 max: 5

    Depends on the number of touchpoints set up in selfserve portal

    display_unit

    string

    enums cid

    acs-answered

    acs-missed-rejected mid

    business-profile

    The display unit where the campaign will be played

    deeplink

    string

    valid link

    The external link to which the request should be routed

    ttl

    string

    min:1 max: 365

    Time to live (in days)

    Content-Type

    Required

    application/json

    Authorization

    Required

    Bearer <token>

    campaigns

    array of objects

    min:1 max: 500

    Campaign Details Object

    campaign_id

    string

    min:1 max: 500

    This can be taken from the self serve portal under the Campaigns tab

    receiver_number

    string

    NA

    216B
    test.json.gz
    Open

    Receiver Number,

    It is a 12 digit number with country code and without + sign ,also we can pass the number in the SHA256 format ,it also should be a 12 digit number with country code but without + sign

    UUID / String

    Unique identifier for the user event. This groups all related actions for a single campaign interaction. To be generated from BE.

    No

    reference_id

    String

    Mapped as an external reference to a user phone number. Can be in following formats :

    • The raw 12 digit phone number (with 2-digit country code) of the user who saw the campaign impression.

    • The SHA256 hashed value of the 12 digit phone number (with 2-digit country code) of the user who saw the campaign impression.

    • The reference_id of the user who saw the campaign impression; mapped to the optional reference_id field in the Payload Exchange API

    Yes

    organisation_id

    String

    Identifier for the Organisation associated with the event.

    No

    campaign_id

    String

    Identifier for the campaign associated with the event.

    No

    display_unit

    String

    Identifier for the display unit where the event was served.

    No

    impression_timestamp

    Timestamp

    The exact date and time when the impression was served.

    No

    click_timestamp

    Timestamp (Optional)

    The exact date and time when the click event occurred. Only populated if a click happened.

    No

    business_number

    String

    The business phone number/sender id which triggered the campaign to the end user.

    No

    event_id

    {
        "message": "Payload received successfully for processing"
    }
    {
        "slug": "internal-server-error",
        "message": "500/50011 - Failed to parse token"
    }
    // Event Structure for Clickstream - Detailed Events
    
    {
        "event_id": "DfK910987654321SNJ",
        "reference_id": "911234567890",
        "organisation_id": "HHSDFZX1234592828SJ299",
        "campaign_id": "Test_campaign",
        "display_unit": "business-profile",
        "impression_timestamp": "1754116200",
        "click_timestamp": "1754118000",
        "business_number": "9122245644890"
    }
    // Event Structure for Clickstream - Click Events
    
    {
        "event_id": "DfK910987654321SNJ",
        "reference_id": "911234567890",
        "organisation_id": "HHSDFZX1234592828SJ299",
        "campaign_id": "Test_campaign",
        "display_unit": "business-profile",
        "impression_timestamp": "1754116200",
        "click_timestamp": "1754118000",
        "business_number": "9122245644890"
    }
    Create a New Webhook: Click on the "Create webhook" button to begin adding a new webhook.
  • Enter Webhook Details:

    • Webhook Name: Provide a descriptive name for your webhook in the designated field. This name will be used to identify the webhook within the Truecaller for Business console. Please ensure the name is unique at any given time and does not exceed 50 characters.

    • Webhook URL: Enter the endpoint to which Truecaller should send the webhook notifications. For enhanced security, you might consider including a self-generated key as part of your URL (e.g., https://server.yourcompany.com/tcbiz-webhook?key=<yourkey>).

  • Select Event Type: Choose the specific type of webhook event you wish to receive notifications for. Currently, webhooks are available for Verified Campaigns-Detailed Whenever a response occurs for these enabled features, we will capture it as an event and send it to your configured URL.

    You can review event logs for your webhooks on both the "Manage Webhooks" page and the dedicated "Webhook events" page. Detailed information for each event is available on its respective event details page, with logs retained for the last 30 days.

  • Finalize Creation: Once all the required details are filled, click "Create." Your webhook will now be successfully set up.

  • Test Your Webhook : After creation, you can test your webhook to ensure it's functioning correctly.

    • Click on "Test Webhook" next to an existing webhook.

    • Select the event you wish to test (the default is "Call Me Back").

    • Click "Test URL" to send a test notification.

  • How does Verified Campaigns work?

    Verified Campaigns can be easily set up through your Customer Engagement Platform (CEP) or Customer Relationship Management (CRM) platform. Here’s how it works:

    • Build: Build your campaign blocks by generating templates, personalizing displays and customizing parameters as required. All necessary authentication details and setup options are available in your Truecaller for Business console, allowing you to manage everything independently.

    • Operate: Add Truecaller as a channel to your existing or new customer journeys on your customer engagement platform, in order to hyper personalize your business calls and SMS.

    • Engage: Engage at scale across use cases like onboarding, activation, nurturing, advocacy and churn. Easily measure and optimize your campaigns on the Truecaller for Business console.

    Business Page

    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

    PDU Aspect Ratio

    320x140

    320x140

    320x140

    320x140

    Title

    40 characters MAX; supports 2 lines

    Business Page

    Display your campaigns directly on your Business Page to engage users with targeted content whenever they view your verified identity. Reinforce your messaging through branded visuals, CTAs, and offers—right where users come to learn more about your business.

    To create the JSON payload structure needed for your webhook connectors, use the DIY Template Generator tool within the Verified Campaigns 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_id : External campaign reference ID

    • 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 - Text only
    Template 2 - Image Banner only
    Template 3 - Personalised content with image banner on left
    Template 4 - Personalised content with image banner on right

    Generate Access Token

    This API is used to generate an access token using the Key ID and Secret API Key created from the Manage API Keys page

    Validity of the auth token is 60min ,post that we need to recall the API for fresh auth token value.

    Replace the {{BaseURL}} with the one mentioned here

    POST {{BaseURL}/organisations/{organisationid}/campaigns/token

    {organisationid}: This can be taken directly from the self serve portal under the API Setup Page

    Headers

    Name
    Value
    Description

    Body

    Name
    Type
    Description

    Request

    Missed Call Pop-up

    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

    Caller ID

    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

    Post Call Pop-up

    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

    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

    >150 KB

    >150 KB

    >150 KB

    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

    How will Verified Campaigns impact my CEP’s billing?

    Verified Campaigns operates independently of your Customer Engagement Platform (CEP) and does not alter its billing structure.

    Since our platform integrates via webhooks, your CEP will continue to charge you based on its existing pricing model—whether that’s based on API calls, events triggered, messages sent, or MAUs (Monthly Active Users).

    Here’s what you need to consider:

    ✔ No Double Charging – Verified Campaigns does not duplicate billing for the same user engagement. If you’re already paying your CEP for event-based triggers, our pricing remains separate and purely based on the unique Truecaller users reached within a calendar month

    ✔ Webhook-Based Triggers – Since Verified Campaigns relies on webhook integrations, any event-triggered campaign may count toward your CEP’s event-based pricing. However, we only process the data you choose to send, ensuring flexibility in managing costs.

    ✔ Optimized Spend – Since Verified Campaigns helps reach customers on existing high-engagement channel (Caller ID, Post Call Screen, Message ID), it can complement your existing CEP strategies by reducing dependency on costlier channels like SMS, push, or email—potentially optimizing your overall marketing spend.

    Note: For specific billing implications related to your CEP contract, please consult your CEP Account Manager or Customer Success teams for appropriate details.

    Please reach out to [email protected] for questions on Verified Campaigns pricing.

    "sub_title"*

    "sub_title"*

    "call_to_action"*

    "call_to_action"*

    "call_to_action"*

    "deeplink"*

    "deeplink"*

    "deeplink"*

    "ttl"

    "ttl"

    "ttl"

    “display_unit”*

    “display_unit”*

    “display_unit”*

    “display_unit”*

    "title"*

    "deeplink"*

    "title"*

    "title"*

    "sub_title"*

    "ttl"

    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

    >150 KB

    >150 KB

    >150 KB

    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

    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

    >150 KB

    >150 KB

    >150 KB

    Redirection

    None

    None

    None

    None

    Image File Hosting

    NA

    CDN bucket

    CDN bucket

    CDN bucket

    Local Lannguage Support

    Yes

    Yes

    Yes

    Yes

    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

    >150 KB

    >150 KB

    >150 KB

    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

    PDU Aspect Ratio

    320x140

    320x140

    320x140

    320x140

    Title

    40 characters MAX; supports 2 lines

    NA

    X-Public-Access

    allow

    Required

    api_key

    string

    Required API key from the API Set up Page

    key_id

    string

    Required Key ID from the API Setup Page

    {
        "api_key": "9325a824-8a9b-4684-99d3-33c10b8ae1d3",
        "key_id": "ad1c032c-2856-4cf8-9b1f-20b555b610d7"
    }
    {
        "token": "a4p0sTtfFbsSfRlm4_CazHEbv0guHq4u0tID1TTe4CX4KIu_20BMgI0Bc7qXdmr7",
        "created_at": "2025-08-19T06:27:31.193Z"
    }
    {
        "slug": "authorization-error",
        "message": "Missing authorization header"
    }

    Template 2 - Image only

    The Image Banner template allows you to leverage your own marketing assets for Verified Campaigns.

    Below are the guidelines for using your own banners on Verified Campaigns:

    Caller ID
    Template 2 - Image only

    PDU Aspect Ratio

    320x140

    Title

    NA

    Post Call Pop-up - Universal
    Template 2 - Image only
    Missed Call Pop-up
    Template 2 - Image only
    Sticky Message ID
    Template 2 - Image only
    Business Profile
    Template 2 - Image only

    Template 4 - Personalised content with image on Right

    Similar to Template 3, this design places the personalized text alongside an image, but with the image on the right side. This layout maintains visual appeal while ensuring the text remains the focal point. Customization options, including background color and text color, enable you to tailor this template to fit your brand identity perfectly.

    Below are the guidelines for creating a banner that has personalized text with CTA and brand Image on the right side:

    Caller ID
    Template 4 - Personalised content with image on right

    Template 3 - Personalised content with image on Left

    This template offers a unique combination of personalized text and a brand image positioned on the left, providing a balanced layout. Personalization helps create a stronger connection with the audience, while the brand image adds visual interest. Customizable aspects like background color and text color allow for further alignment with your brand.

    Below are the guidelines for creating a banner that has personalized text with CTA and brand Image on the left side:

    Caller ID
    Template 3 - Personalised content with image on left

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Sub Title

    NA

    CTA

    NA

    Image Dimensions

    W 320 x H 140

    Image File Format

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    None

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    PDU Aspect Ratio

    320x140

    Title

    NA

    Sub Title

    NA

    CTA

    NA

    Image Dimensions

    W 320 x H 140

    Image File Format

    PDU Aspect Ratio

    320x140

    Title

    NA

    Sub Title

    NA

    CTA

    NA

    Image Dimensions

    W 320 x H 140

    Image File Format

    .jpeg, .png and .gif supported

    PDU Aspect Ratio

    320x100

    Title

    NA

    Sub Title

    NA

    CTA

    NA

    Image Dimensions

    W 320 x H 100

    Image File Format

    .jpeg, .png and .gif supported

    PDU Aspect Ratio

    320x140

    Title

    NA

    Sub Title

    NA

    CTA

    NA

    Image Dimensions

    W 320 x H 140

    Image File Format

    .jpeg, .png and .gif supported

    .jpeg, .png and .gif supported

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    NA

    Image Dimensions

    100x140

    Image File Format

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    None

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Post Call Pop-up - Universal
    Template 4 - Personalised content with image on right

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x140

    Image File Format

    Missed Call Pop-up
    Template 4 - Personalised content with image on right

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x140

    Image File Format

    Sticky Message ID
    Template 4 - Personalised content with image on right

    PDU Aspect Ratio

    320x100

    Title

    25 characters MAX; supports 2 lines

    Sub Title

    NA

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x100

    Image File Format

    Business Profile
    Template 4 - Personalised content with image on right

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x140

    Image File Format

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    NA

    Image Dimensions

    100x140

    Image File Format

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    None

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Post Call Pop-up - Universal
    Template 3 - Personalised content with image on left

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x140

    Image File Format

    Missed Call Pop-up
    Template 3 - Personalised content with image on left

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x140

    Image File Format

    Sticky Message ID
    Template 3 - Personalised content with image on left

    PDU Aspect Ratio

    320x100

    Title

    25 characters MAX; supports 2 lines

    Sub Title

    NA

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x100

    Image File Format

    Business Profile
    Template 3 - Personalised content with image on left

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    100x140

    Image File Format

    PDU Aspect Ratio

    320x140

    Title

    Template 1 - Customisable Text-only

    This template features a straightforward design that effectively communicates your message with a clear call-to-action (CTA). It allows for customization of specific aspects, such as background color and text color, to match your branding. This option is perfect for businesses looking to deliver concise information without distractions.

    Below are the guidelines for a text banner on Verified Campaigns:

    Caller ID
    Template 1 - Customisable Text-only

    PDU Aspect Ratio

    320x140

    Title

    Post Call Pop-up - Universal
    Template 1 - Customisable Text-only
    Missed Call Pop-up
    Template 1 - Customisable Text-only
    Verified Message ID
    Template 1 - Customisable Text-only
    Business Profile
    Template 1 - Customisable Text-only

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    .jpeg, .png and .gif supported

    Image File Size

    <150 KB

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    CDN bucket

    Local Language Support

    Yes

    Image File Size

    NA

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    NA

    Local Language Support

    Yes

    Image File Size

    NA

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    NA

    Local Language Support

    Yes

    Image File Size

    NA

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    NA

    Local Language Support

    Yes

    Image File Size

    NA

    Redirection

    Landing page on mobileweb browser or app deeplink supported

    Image File Hosting

    NA

    Local Language Support

    Yes

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    NA

    Image Dimensions

    NA

    Image File Format

    NA

    Image File Size

    NA

    Redirection

    None

    Image File Hosting

    NA

    Local Language Support

    Yes

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    NA

    Image File Format

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    NA

    Image File Format

    PDU Aspect Ratio

    320x100

    Title

    25 characters MAX; supports 2 lines

    Sub Title

    NA

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    NA

    Image File Format

    PDU Aspect Ratio

    320x140

    Title

    40 characters MAX; supports 2 lines

    Sub Title

    60 characters MAX; supports 2 lines

    CTA

    15 characters MAX; supports 1 line

    Image Dimensions

    NA

    Image File Format

    NA

    NA

    NA

    NA

    Asset Dimensions

    Get to know more about the various asset dimensions that show up on the different Verified Business interfaces.

    Caller ID
    Post Call Pop-up
    Missed Call Pop-up
    Sticky Message ID
    Business Page

    Can we host our marketing assets on the console?

    Yes, you can host your marketing assets directly on the Truecaller Business console.

    We store these assets in a CDN-backed storage bucket on Google Cloud Platform (GCP), enabling near real-time delivery of marketing campaigns even on low-latency or high-traffic networks.

    This ensures your campaign assets are hosted securely and load quickly and reliably for end users across regions.