Get Call
Retrieve detailed information about a specific call by its ID.
This endpoint provides comprehensive information about any call (web or phone) including its current status, duration, and associated metadata.
Path Parameters
Response
Current status of the call: 'registered' for initialized calls, 'ongoing' for active calls, 'ended' for completed calls, 'error' for failed calls
registered
, ongoing
, ended
, error
Unique identifier for the call session, automatically generated as a MongoDB ObjectId
Identifier of the AI agent handling this call
Name of the AI agent handling this call
Optional identifier for an alternative AI agent handling this call
Custom key-value pairs storing additional information about the call
Dynamic data used by the AI agent during the call
Timestamp when the call was initiated, in UTC
Timestamp when the call was terminated, in UTC
Chronological list of messages exchanged during the call
URL to access the recorded audio file of the call
Security token for accessing call-related resources
Duration of the call in seconds
Indicates this response is for a web-based call
"web_call"
Detailed reason why the web call ended, if applicable
user_ended_call
, agent_ended_call
, call_transferred
, inactivity_timeout
, maximum_duration_exceeded
, concurrent_call_limit_reached
, invalid_payment
, potential_scam_detected
, inbound_webhook_error
, line_busy
, call_failed
, no_answer
, llm_websocket_initialization_error
, llm_websocket_connection_lost
, llm_websocket_runtime_error
, llm_websocket_payload_corruption
, twilio_error
, no_audio_input
, speech_recognition_error
, pia_platform_internal_error
, unknown_error
, user_connection_failure
Current status of the call: 'registered' for initialized calls, 'ongoing' for active calls, 'ended' for completed calls, 'error' for failed calls
registered
, ongoing
, ended
, error
Unique identifier for the call session, automatically generated as a MongoDB ObjectId
Identifier of the AI agent handling this call
Name of the AI agent handling this call
Optional identifier for an alternative AI agent handling this call
Custom key-value pairs storing additional information about the call
Dynamic data used by the AI agent during the call
Timestamp when the call was initiated, in UTC
Timestamp when the call was terminated, in UTC
Chronological list of messages exchanged during the call
URL to access the recorded audio file of the call
Security token for accessing call-related resources
Duration of the call in seconds
Indicates this response is for a web-based call
"web_call"
Detailed reason why the web call ended, if applicable
user_ended_call
, agent_ended_call
, call_transferred
, inactivity_timeout
, maximum_duration_exceeded
, concurrent_call_limit_reached
, invalid_payment
, potential_scam_detected
, inbound_webhook_error
, line_busy
, call_failed
, no_answer
, llm_websocket_initialization_error
, llm_websocket_connection_lost
, llm_websocket_runtime_error
, llm_websocket_payload_corruption
, twilio_error
, no_audio_input
, speech_recognition_error
, pia_platform_internal_error
, unknown_error
, user_connection_failure
Current status of the call: 'registered' for initialized calls, 'ongoing' for active calls, 'ended' for completed calls, 'error' for failed calls
registered
, ongoing
, ended
, error
The phone number that initiated the call (E.164 format)
The phone number that received the call (E.164 format)
Indicates whether the call was received by or initiated from the Pia Platform
inbound
, outbound
Unique identifier for the call session, automatically generated as a MongoDB ObjectId
Identifier of the AI agent handling this call
Name of the AI agent handling this call
Optional identifier for an alternative AI agent handling this call
Custom key-value pairs storing additional information about the call
Dynamic data used by the AI agent during the call
Timestamp when the call was initiated, in UTC
Timestamp when the call was terminated, in UTC
Chronological list of messages exchanged during the call
URL to access the recorded audio file of the call
Security token for accessing call-related resources
Duration of the call in seconds
Indicates this response is for a telephone call
"phone_call"
Detailed reason why the phone call ended, if applicable
user_ended_call
, agent_ended_call
, call_transferred
, voicemail_detected
, inactivity_timeout
, answering_machine_detected
, maximum_duration_exceeded
, concurrent_call_limit_reached
, invalid_payment
, potential_scam_detected
, inbound_webhook_error
, line_busy
, call_failed
, no_answer
, llm_websocket_initialization_error
, llm_websocket_connection_lost
, llm_websocket_runtime_error
, llm_websocket_payload_corruption
, frontend_payload_corruption
, twilio_service_error
, no_audio_input
, speech_recognition_error
, retell_service_error
, unknown_error
, user_connection_failure
, registered_call_timed_out