Call Personalisation Batch v3

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

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

POST {{BaseURL}}/v3/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

Request

JSON

{
  "call_records": [
    {
      "caller_number": "[phone]",
      "receiver_number": "[phone]",
      "label_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "starts_at": 1770118258000,
      "ends_at": 1770121858000,
      "dynamic_label_name": "Acme Support",
      "dynamic_call_reason": "Regarding your recent order"
    },
    {
      "caller_number": "[phone]",
      "receiver_number": "[phone]",
      "label_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "starts_at": 1770118258000,
      "ends_at": 1770121858000,
      "dynamic_label_name": "Acme Delivery",
      "dynamic_call_reason": "Your order is out for delivery"
    }
  ]
}

Response

200 OK

{
  "batch_id": "5909638a-a8a7-4a86-8970-d576e9717887"
}

401 Unauthorized

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

403 Feature access denied

{
  "status_info": {
    "status": "error",
    "message": "Please request admin for feature access to create Dynamic Caller ID"
  }
}

429 Rate limit exceeded

{
  "slug": "too-many-requests",
  "message": "rate limit exceeded"
}

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	Format Supported:"[phone]"	Required The phone number of the caller, in E.164 format.
ends_at	integer (int64)	Epoch timestamp in milliseconds	Required The timestamp, in milliseconds, at which the dynamic caller ID should expire. Must not be in the past and must be no more than 24 hours after starts_at
label_id	string	NA	Optional The label ID of the dynamic label to be used as the caller ID. Must belong to the client account.
dynamic_label_name	string	minLength: 3 maxLength: 40	Optional The caller ID name to be displayed. If omitted, defaults to the name of the provided label.
receiver_number	string	Format Supported:"[phone]"	Required The phone number of the receiver, in E.164 format.
starts_at	integer (int64)	Epoch timestamp in milliseconds	Required The timestamp, in milliseconds, at which the dynamic caller ID should start reflecting.