Get a Specific Call History
Retrieve detailed information about a specific call history entry.
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
callHistoryIdstringrequiredThe unique identifier of the call record in the database.
Response Fields
_idstringThe unique identifier for the call history record.
workspaceIdstringThe identifier of the workspace associated with this call history.
agentIdstringThe identifier of the agent involved in the call.
callFlowIdstringThe identifier of the call flow used during the call.
roomNamestringThe virtual room name where the call took place.
directionstringThe direction of the call (e.g., "inbound" or "outbound").
fromPhoneNumberstringThe phone number from which the call originated.
toPhoneNumberstringThe phone number to which the call was made.
statusstringThe final status of the call (e.g., "completed", "failed", "ongoing").
startTimenumberThe start time of the call as a Unix timestamp.
endTimenumberThe end time of the call as a Unix timestamp.
costobjectDetails of the costs incurred during the call.
customer_chargenumberThe charge to the customer for the call.
metadataobjectAdditional metadata associated with the call.
functionCallsarrayAn array detailing any functional calls made during the interaction.
summarystringA brief summary of the call.
analyzedDataobjectAnalyzed data from the call that may include additional fields.
additional_fieldstringAdditional details from the analyzed data.
createdAtstringTimestamp when the call history was created.
updatedAtstringTimestamp when the call history was last updated.
{
"_id": "1234567890abcdef",
"workspaceId": "abcdef1234567890",
"agentId": "abcdef1234567890",
"callFlowId": "abcdef1234567890",
"roomName": "web-1234abcd",
"direction": "outbound",
"fromPhoneNumber": "+10000000000",
"toPhoneNumber": "+10000000001",
"status": "completed",
"startTime": 1680000000,
"endTime": 1680000300,
"cost": {
"customer_charge": 0.10
},
"metadata": {},
"functionCalls": [],
"summary": "Generic conversation summary about customer engagement.",
"analyzedData": {
"additional_field": "generic details"
},
"createdAt": "2025-01-01T10:00:00Z",
"updatedAt": "2025-01-01T10:05:00Z"
}