Call Personalisation Batch v2

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

Replace the {{BaseURL}} with the one mentioned here

POST {{BaseURL}}/v2/clients/{clientAccountId}/dynamic_call_records

{clientAccountId} : This can be taken directly from the self serve portal under the Manage API Keys Page

This API can handle 60 requests per minute per token.

For Authorization Token kindly refer the Authentication section followed by Generate Access Token API

Headers

Name	Value
Content-Type	Required application/json
Authorization	Required Bearer <token>

Body

Name	Type	Validations	Description
call_records	array of object	min:1 max: 500	Required Call record object Maximum batch size is 500 per API Call
dynamic_call_reason	string	minLength: 10 maxLength: 100	Optional The call reason to be displayed.
caller_number	string	NA	Required The phone no. of the caller
ends_at	integer (int64)	Epoch timestamp in milliseconds	Required The timestamp in milliseconds at which dynamic caller ID should expire. Should not be before the current timestamp. starts_at and ends_at cannot be more than 24 hrs apart
label_id	string	NA	Optional The label ID of the dynamic label to be used as caller id
dynamic_label_name	string	minLength: 3 maxLength: 40	Required The caller ID name to be displayed. If not present it will default to the label name of the label ID provided.
receiver_number	string	NA	Required The phone no. of the receiver
starts_at	integer (int64)	Epoch timestamp in milliseconds	Required The timestamp in milliseconds at which dynamic caller ID should start reflecting. starts_at and ends_at cannot be more than 24 hrs apart

Request

JSON

{
  "call_records":[
        {
          "label_id": "c6d86658-008d-4c08-98fb-2bf2649d59a5",
          "dynamic_label_name": "Centro Bank KYC Department",
          "dynamic_call_reason":  "Calling you for KYC Verification",
          "caller_number": "[phone]",
          "receiver_number": "914567867865",
          "starts_at": 1753246858000,
          "ends_at": 1753362058000
        }
      ]
}

Response

200 OK

{
    "batch_id": "b72f7a40-ec3a-462f-b528-da0e8dc87e79"
}

401 Unauthorized

{
    "slug": "authorization-error",
    "message": "please login again"
}