[POST] Call Personalisation (Bulk)

Async API to send call personalisation data for a Caller-Receiver combination

Create Dynamic Call Records

This endpoint pushes the dynamic caller ID details to the respective TC users. It supports batching. Maximum batch size is 500

POST/clients/{clientAccountId}/dynamic_call_records

Authorization

Bearer

Path parameters

clientAccountId*string (uuid)

This should be the clientAccountId

Header parameters

Body

application/json

call_recordsarray of DynamicCallRecordParams (object)

Response

200400401500

Body

application/json

batch_idstring

records_uploadedinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('/clients/{clientAccountId}/dynamic_call_records', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401500

{
  "batch_id": "text",
  "records_uploaded": 0
}

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.

Rate limits

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.

Adapting to rate-limits

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