Call Personalisation Real-time v2

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

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

POST {{BaseURL}}/v2/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:"91**********"	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

{
    "label_id": "c6d86658-008d-4c08-98fb-2bf2649d59a5",
    "dynamic_label_name": "Flower rasm",
    "dynamic_call_reason": "Flower Delivery",
    "caller_number": "918861277591", 
    "receiver_number": "919035712806",
    "starts_at": 1753088751000,
    "ends_at": 1753103151000
}

Response

200 OK

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

400 Bad Request

{
    "status_info": {
        "status": "error",
        "field": "ends_at",
        "message": "Request body is invalid: ends_at cannot be older than current time"
    }
}