[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

post

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

Authorizations

Path parameters

clientAccountIdstring · uuidRequired

This should be the clientAccountId

Header parameters

AcceptstringOptionalExample: {"value":"application/vnd.api+json; version=1.0"}

Body

call_reasonstringOptional

The call reason to be displayed.

callerstringRequired

The phone no. of the caller

ends_atinteger · int64Required

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

label_idstring · uuidRequired

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

label_namestringOptional

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

receiverstringRequired

The phone no. of the receiver

starts_atinteger · int64Required

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

Responses

200Success

400Error

401Error

500Error

post

HTTPcURLJavaScriptPython

POST /clients/{clientAccountId}/dynamic_call_record HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "call_reason": "text",
  "caller": "text",
  "ends_at": 1,
  "label_id": "123e4567-e89b-12d3-a456-426614174000",
  "label_name": "text",
  "receiver": "text",
  "starts_at": 1
}

No content

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