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 100 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
Previously created dynamic labels can be fetched by hitting the below API endpoint.
Base URL :
This endpoint returns all dynamic labels under a client. It supports pagination. It will return an empty array if no labels are found.
This should be the clientAccountId
Determines the set of records to return. Defaults to 1.
1
Determines the no. of records to be returned. Defaults to 1000.
1
"application/vnd.api+json; version=1.0"
This endpoint pushes the dynamic caller ID details to the respective TC users in realtime.
This should be the clientAccountId
"application/vnd.api+json; version=1.0"
The call reason to be displayed.
The phone no. of the caller
The timestamp in milliseconds at which dynamic caller ID should expire.
The label ID of the dynamic label to be used as caller id
The caller ID name to be displayed. If not present it will default to the label name of the label ID provided.
The phone no. of the receiver
The timestamp in milliseconds at which dynamic caller ID should start reflecting.
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
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 100 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.
Fetch status of records for Batch-ID returned in the Bulk Call Personalisation API.
Each record indicates whether the record was successfully pushed or not.
This should be the clientAccountId
This is received from the Create Dynamic Call Records API response
"application/vnd.api+json; version=1.0"
This endpoint pushes the dynamic caller ID details to the respective TC users. It supports batching. Maximum batch size is 500
This should be the clientAccountId
"application/vnd.api+json; version=1.0"
The call reason to be displayed.
The phone no. of the caller
The timestamp in milliseconds at which dynamic caller ID should expire.
The label ID of the dynamic label to be used as caller id
The caller ID name to be displayed. If not present it will default to the label name of the label ID provided.
The phone no. of the receiver
The timestamp in milliseconds at which dynamic caller ID should start reflecting.