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...
You can use Call Personalisation APIs to list numbers with a verified identity on Truecaller for a fixed duration of time. Power this verified identity with personalized context delivery for each call record that is pushed to our systems, and deliver personalized value to your customers.
Calling operations done through non-company owned numbers where a permanent identity cannot be listed.
Scheduled calling operations that are run daily, where your business wants to add a clean identity and personalized call context for optimal performance.
Calls often made from one business number to multiple users.
Refreshing your identity on Truecaller easily, if your business has limited calling numbers.
Dynamic Label ID: Only “Dynamic Label IDs” can be used in the API request for placing calls.
A subscription to a package that includes Call Personalisation APIs.
Log in to the Truecaller for Business console.
Navigate to Business Identity in the left hand side panel.
Click on "Identity" and then go to the Caller ID Details section.
Click on "Create a Label".
Select the caller ID type as Dynamic Caller ID.
Add a logo for your dynamic caller ID. The logo should be a PNG file, with dimensions 200x200 and file size less than 2 MB.
Add a label name of less than 40 characters for your Dynamic Caller ID.
Choose the category for your business from the dropdown after creating a label name.
Click on "Create Caller ID' to finish creating your dynamic caller ID.
If your business is interested in knowing more about Call Personalisation APIs, please reach out to -> cs@truecaller.com
Number management APIs are super handy for businesses that want to automate management of business numbers on Truecaller platform. These APIs come packed with features to help you handle everything, such as:
Listing numbers as verified numbers.
Delisting numbers that are no longer in use.
Get information of verified number(s).
Get feature set ID to manage numbers inside feature sets.
By using these APIs, you can make automate your number ownership and management tasks way easily, ensuring your numbers reflect their true profiles.
Just a heads up, before diving in, you'll need to:
Generate an authentication token
Create an API key
This ensures you get secure access and can interact with the number management services.
Generates an access token to access Truecaller for Business APIs.
Base URL is : https://enterprise-portal-noneu.truecaller.com
Access Token rate limits:
Requests Per Minute (RPM): The maximum number of requests allowed within a one-minute time window.
A maximum of 10 tokens can be created every 30 minutes.
This API allows you to generate access token that grants you access to Truecaller for Business endpoints.
Welcome to the API documentation section of our Verified Business Caller ID solution! Discover how you can use our easy-to-integrate APIs to streamline your processes and drive efficiency. Our comprehensive documentation provides everything you need to get started and unleash the full potential of our solution.
The Call Me Back API helps you to download Call Me Back requests for the numbers for which this feature has been enabled.
Create an API Key for Call Me Back.
Generate the required access token.
Hit the below endpoint to get logs.
The response is a URL through which the logs can be downloaded.
Previously created dynamic labels can be fetched by hitting the below API endpoint.
Async API to send call personalisation data for a Caller-Receiver combination
Here are a few things to consider when pushing the records through the API :-
Caller and receiver should be phone numbers without the “+” character.
ends_at should not be before the current timestamp.
starts_at and ends_at cannot be more than 24 hrs apart
label_id should be that of a dynamic label belonging to this client.
Label name and call reason are optional fields.
Max length for label name is 40 chars
Min length for call reason is 10 chars
Max length for call reason is 50 chars
starts_at and ends_at should be in milliseconds.
Truecaller for Business restricts API requests when you exceed the limits entitled to your business.
Thus, if your business is using a batch based approach to push records to our systems, 10*60*500 = 300000 records can be processed every minute.
Here, the batch size is 500. This means that a maximum of 500 requests can be processed at a time.
Exponential Backoff: If you receive a "429" status code, consider implementing exponential backoff for retrying requests.
Prioritize Important Requests: If your application performs various tasks, prioritize critical requests over less essential ones to stay within limits.
This API allows you to download logs for user feedback campaigns.
Sync API to send call personalisation data for a Caller-Receiver combination. This is a real-time API
Here are a few things to consider when pushing the records through the API :-
Caller and receiver should be phone numbers without the “+” character.
ends_at should not be before the current timestamp.
starts_at and ends_at cannot be more than 24 hrs apart
label_id should be that of a dynamic label belonging to this client.
Label name and call reason are optional fields.
Max length for label name is 40 chars
Min length for call reason is 10 chars
Max length for call reason is 50 chars
starts_at and ends_at should be in milliseconds.
Truecaller for Business restricts API requests when you exceed the limits entitled to your business.
Each token can handle 100 requests per second
Maximum of 10 tokens can be created in every 30 minutes
API keys are used to ensure the authenticity of interactions between your application and Truecaller for Business APIs.
Truecaller for Business uses API keys for authenticating API requests.
You can view and manage your API keys from the Truecaller for Business console.
Click on “Manage API Keys” from the overflow menu beside the account name in the left hand side panel of the console.
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.
Customers are allowed to generate 5 API keys for concurrent use at a time.
Customers will not be able to see the secret key and key ID once generated. It is advised that you should copy the secret key and key ID and save it in a safe and secure folder.
Base URL :
for User Feedback.
Base URL :
In order to notify your systems for events related to features in your enterprise plan, Webhooks (or HTTP callbacks) can be configured on the Self-serve platform.
Currently, webhooks are available for two features: Call Me Back and User Feedback. If you are interested in knowing more about webhooks, please feel free to reach out to: cs@truecaller.com
A webhook can only be tested after it is created. Below are the steps to test a Webhook:
Click on Test Webhook on an existing webhook.
Choose the event to test (The current default selection is Call Me Back).
Click on Test URL.
Whenever there is a response to the enabled features you have set up with a webhook, we will catch it as an event. Right now, we are all set to capture Call Me Back and User Feedback events.
A webhook can be attached to one or both of the Call Me Back and User Feedback events.
Event logs for your webhooks can be found from Manage Webhooks page or Webhook events page.
Details of events related to the webhook can be found in the event details page. Events are shown for the period of last 30 days.
Fetch status of records for Batch-ID returned in the Bulk Call Personalisation API.
Use this API is used to list your business numbers
Feature-set ID can be fetched from the get feature-set API.
This API is used to get feature-set ID to list and delist numbers.
To configure your webhooks, click on the overflow menu and click on "Manage Webhooks".
Click on “Create webhook” to add a new webhook.
Add the name of the webhook in the field provided. The name should not exceed 50 characters.
Add the webhook URL.
Select the type of webhook event (Call Me Back or User Feedback), as per your requirement.
Once all details have been filled, click on "Create". Your wehook has now been created.
You can click on "Test Webhook" to test the webhook you have created for a particular event.
A total of 5 webhooks can be configured under a customer account.
This API is used to get meta-data of listed business numbers like their updated at, created by etc.
This API is used to delist and remove business numbers from the client account and its feature-set.
The Webhook Name is the name by which the webhook will be referred to in the Truecaller for Business console. The Webhook URL represents the endpoint to which the webhook should be sent.
One way of authenticating a webhook call is by including a key generated by you, as part of the webhook URL. For example, the URL could look like:
Webhook Name should be unique at a given time. All the configured webhooks should have a different name.
To change a webhook’s configuration or to delete it, click on the overflow menu beside the Test webhook button.
Configure your systems to consume webhook response by assigning appropriate fields based on your self-serve configurations.
Use this response structure if your feature enabled numbers are under process configurations -> Feature-sets. i.e This response structure is for customers which are on the new self-serve console.
Payload - Call Me Back
Payload - User Feedback
Use this response structure if your feature configurations are tied to number groups. i.e This response structure is for customers which are on the old self-serve console.
Payload - Call Me Back
Payload - User Feedback
We support Call Me Back and User Feedback events for webhooks. Each event has its resources that can be referred from the resource column.
There are 3 timeouts for Webhooks provided by Truecaller for Business:
Connection Timeout: The connection timeout is the timeout for making the initial connection to the webhook URL's HTTP server.
Read Timeout: Once the initial connection has been made, there is a possibility that there is an indefinite wait to read data from the HTTP server at any time. The read timeout is the timeout for such a wait.
Total Webhook Timeout: In addition to the above timeouts, Truecaller for Business also checks the total execution of time of any webhook call via the webhook execution timeout.
The values for each timeout are as follows:
Webhook execution can fail due to timeouts or errors. For each event where webhook call fails, the calls are retried up to 7 times based on the following schedules:
This is mentioned in the event details page.
Event | Trigger | Resources |
---|
Timeout | Duration |
---|
Retry | Time |
---|
Call me back | When a user requests a call me back from the Truecaller App in the scenario of a missed / rejected call |
|
User Feedback | When a user responds to a campaign based on the type of call, answered or missed / rejected. This response is from the campaign on the Truecaller app. |
|
Connection Timeout | 20,000 ms |
Read Timeout | 20,000 ms |
Webhook Execution Timeout | 60,000 ms |
1 | 2 minutes after the failure |
2 | 6 minutes after the previous retry |
3 | 30 minutes after the previous retry |
4 | 1 hour after the previous retry |
5 | 5 hours after the previous retry |
6 | 1 day after the previous retry |
7 | 2 days after the previous retry |
There are 3 error scenarios for webhooks:
Webhook not found
Events:
Rescheduled error
Webhook Deleted
Webhook Failed: When webhook fails an email is sent to the user.