[POST] Call Personalisation

Sync API to send call personalisation data for a Caller-Receiver combination. This is a real-time API

Create Realtime Dynamic Call Record

This endpoint pushes the dynamic caller ID details to the respective TC users in realtime.

POST/clients/{clientAccountId}/dynamic_call_record

Authorization

Bearer

Path parameters

clientAccountId*string (uuid)

This should be the clientAccountId

Header parameters

Body

application/json

call_reasonstring

The call reason to be displayed.

caller*string

The phone no. of the caller

ends_at*integer (int64)

The timestamp in milliseconds at which dynamic caller ID should expire.

label_id*string (uuid)

The label ID of the dynamic label to be used as caller id

label_namestring

The caller ID name to be displayed. If not present it will default to the label name of the label ID provided.

receiver*string

The phone no. of the receiver

starts_at*integer (int64)

The timestamp in milliseconds at which dynamic caller ID should start reflecting.

Response

200400401500

Body

application/json

messagestring

statusstring

Request

JavaScriptCurlPython

const response = await fetch('/clients/{clientAccountId}/dynamic_call_record', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "caller": "text",
      "receiver": "text",
      "label_id": "123e4567-e89b-12d3-a456-426614174000",
      "starts_at": 0,
      "ends_at": 0
    }),
});
const data = await response.json();

Response

200400401500

{
  "message": "text",
  "status": "text"
}

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.

• Each token can handle 100 requests per second

• Maximum of 10 tokens can be created in every 30 minutes