Call Personalisation Real-time v2

Real-time synchronous API to personalize calls for a given Caller-Receiver combination

Create Realtime Dynamic Call Record

post

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

Authorizations
Path parameters
clientAccountIdstringRequired

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.

Example: Sample call reason
callerstringRequired

The phone no. of the caller

Example: 911234567890
ends_atinteger · int64Required

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

Example: 1748889600000
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.

Example: Display Caller Name
receiverstringRequired

The phone no. of the receiver

Example: 919876543210
starts_atinteger · int64Required

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

Example: 1748860800000
Responses
200
createRealtimeDCIDResponseV2
application/json
post
POST /v2/clients/{clientAccountId}/dynamic_call_record HTTP/1.1
Host: enterprise-portal-noneu.truecaller.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "call_reason": "Sample call reason",
  "caller": "911234567890",
  "ends_at": 1748889600000,
  "label_id": "123e4567-e89b-12d3-a456-426614174000",
  "label_name": "Display Caller Name",
  "receiver": "919876543210",
  "starts_at": 1748860800000
}
{
  "field": "ends_at",
  "message": "Request body is invalid: ends_at cannot be more than 24 hours after starts_at",
  "status": "error"
}
PreviousCall PersonalisationNextCall Personalisation Batch v2

Last updated

Was this helpful?