Call Personalisation Batch v2

Create Dynamic Call Records

post

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

Authorizations
Path parameters
clientAccountIdstring · uuidRequired

This should be the clientAccountId

Header parameters
AcceptstringOptionalExample: {"value":"application/vnd.api+json; version=1.0"}
Body
Responses
200

createDynamicCallRecordsResponseV2

application/json
post
POST /v2/clients/{clientAccountId}/dynamic_call_records HTTP/1.1
Host: enterprise-portal-noneu.truecaller.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "call_records": [
    {
      "caller_number": "911234567890",
      "dynamic_call_reason": "Sample call reason",
      "dynamic_label_name": "Display Caller Name",
      "ends_at": 1748889600000,
      "label_id": "123e4567-e89b-12d3-a456-426614174000",
      "receiver_number": "919876543210",
      "starts_at": 1748860800000
    }
  ]
}
{
  "batch_id": "d76s5-dfg9d-o32442-837467854"
}

Get Dynamic Call Records by Batch

get

Each record indicates whether the record was successfully pushed or not.

Authorizations
Path parameters
clientAccountIdstring · uuidRequired

This should be the clientAccountId {uuid}

Example: {"value":"1eae60d1-9d16-4e4f-975f-914c8dcd9bc6"}
Query parameters
batchIdstring · uuidRequired

This is received from the Create Dynamic Call Records API response {uuid}

Example: {"value":"62401a57-3b2a-41e5-a375-0cde5fc80d60"}
Header parameters
AcceptstringOptionalExample: {"value":"application/vnd.api+json; version=1.0"}
Responses
200

listDynamicCallRecordsResponseV2

application/json
get
GET /v2/clients/{clientAccountId}/dynamic_call_records HTTP/1.1
Host: enterprise-portal-noneu.truecaller.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "batch_id": "75e068d2-eb3d-499c-8c4c-a12445e8c6ce",
  "client_account_id": "40f4175e-6abd-450c-bcd4-058ff953c899",
  "data": [
    {
      "caller": "918898001608",
      "created_at": "2024-02-28T17:07:54.194Z",
      "ends_at": 1709225960000,
      "id": "9acf35fd-ee6c-4409-9803-fc3d90a53109",
      "name": "package Delivery",
      "reason": "Call for your order delivery",
      "receiver": "918310155823",
      "starts_at": 1709139560000,
      "statusInfo": {
        "message": "Receiver's device, app version, or operating system is not compatible",
        "status": "failure"
      },
      "update_at": "2024-02-28T17:07:54.194Z"
    }
  ]
}
PreviousCall Personalisation Real-time v2NextCall Personalisation Real-time (to be deprecated)

Last updated

Was this helpful?