List Call Histories
Retrieve a list of call history records in your workspace.
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Response Fields
_idstringThe unique identifier for the call history record.
timestampnumberThe Unix timestamp indicating when the call was made.
callIdstringA unique identifier associated with the specific call.
fromPhoneNumberstringThe phone number from which the call originated.
toPhoneNumberstringThe phone number to which the call was directed.
directionstringThe direction of the call, typically "inbound", "outbound", or "bidirectional".
agentstringThe name or identifier of the agent involved in the call.
statusstringThe status of the call, such as "active", "completed", or other relevant statuses.
callFlowNamestringThe name of the call flow used during the call.
costnumberThe cost incurred for the call, if applicable.
recordingUrlstringA URL pointing to the recorded audio of the call, if available.
summarystringA brief summary or overview of the call.
analyzedDataobjectAn object containing additional analyzed data from the call, such as flags for voicemail detection or other specific features.
answered_by_voicemailbooleanIndicates whether the call was answered by a voicemail system.
variablesobjectAny variables that were used or modified during the call.
transcriptarrayAn array containing elements of the call transcript, if available.
[
{
"_id": "00000000bf7ca4a7c69e0000",
"timestamp": 1737062894.9754236,
"callId": "00000000013bd867b55ca000-00t00imaqj",
"fromPhoneNumber": "+00000000000",
"toPhoneNumber": "+00000000000",
"direction": "bidirectional",
"agent": "SampleAgent",
"status": "active",
"callFlowName": "Example Call Flow",
"cost": 0,
"recordingUrl": null,
"summary": "Call summary here",
"analyzedData": {},
"variables": {},
"transcript": []
},
{
"_id": "00000000cbddbe9988450000",
"timestamp": 1737061847.891025,
"callId": "00000000013bd867b55ca000-00pk0su000",
"fromPhoneNumber": "+00000000000",
"toPhoneNumber": "+00000000000",
"direction": "bidirectional",
"duration": 0,
"agent": "SampleAgent",
"status": "completed",
"callFlowName": "Example Call Flow",
"cost": 0,
"recordingUrl": null,
"summary": "Call summary here",
"analyzedData": {
"answered_by_voicemail": false
},
"variables": {},
"transcript": []
}
]