For the complete documentation index, see llms.txt. This page is also available as Markdown.

Call Personalization Batch v2 Status

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

GET {{BaseURL}}/v3/clients/{clientAccountId}/dynamic_call_records

Headers

Name
Value

Content-Type

Required

application/json

Authorization

Required

Bearer <token>

Query Parameter

Name
Value
Type

batchId

Required

This is received from the Create Dynamic Call Records API response

string

Response

Name
Type
Validations
Description

client_account_id

string

NA

Client account id of the account.

batch_id

string

NA

Identifier of the created batch. Use this with the Get Dynamic Call Records by Batch endpoint to poll per-record processing status.

Example"5909638a-a8a7-4a86-8970-d576e9717887"

dynamic_call_reason

string

minLength: 10 maxLength: 100

Optional.

The call reason to be displayed.

id

string

NA

Unique identifier of the individual dynamic call record (distinct frombatch_id, which groups multiple records).

caller_number

string

Format Supported:"+911234567890"

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:"+919876543210"

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.

status_info

object

NA

status

string

NA

Processing status of the record or request. Possible Enum

  • #0"success"

  • #1"error"

  • #2"initiated"

  • #3"validated"

Example"success"

message

string

NA

Human-readable status or error message. Example"Record processed successfully"

created_at

string

NA

Server-assigned UTC timestamp of when the record was created

Last updated

Was this helpful?