Call Personalisation Real-time v3

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

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

POST {{BaseURL}}/v3/clients/{clientAccountId}/dynamic_call_record

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

This API can handle 100 requests per second 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
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.

Request

JSON

{
    "caller_number": "[phone]",
    "receiver_number": "[phone]",
    "label_id": "40621e8c-2097-41d6-9d87-c136c07b1f0e",
    "starts_at": 1784530064000,
    "ends_at": 1784616502000,
    "dynamic_label_name": "Delivery",
    "dynamic_call_reason": "Order out for delivery"
}

Response

200 OK

{
    "status_info": {
        "status": "success",
        "message": "Record processed successfully"
    }
}

400 Bad Request

{
  "status_info": {
    "status": "error",
    "field": "receiver_number",
    "message": "Request body is invalid: Please check receiver number"
  }
}

401 Unauthorized

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