Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.voicy.co/llms.txt

Use this file to discover all available pages before exploring further.

The full Call object contains all information about a voice call, including status, transcript, recording, and variables. Returned by Get Call.
List Calls returns a lightweight version of this object that omits transcript, summary, recording_url, detected_gender, vars_provided, vars_extracted, and vars_collected for performance. Use Get Call to retrieve the full object.

​
Properties

​
call_id
string
required
Unique identifier for the call (UUID).
​
call_type
string
required
Type of call: phone_call or web_call.
​
call_status
string
required
Current status of the call.In Progress:
StatusDescription
initiatedCall placed, waiting for recipient
ringingRecipient’s phone is ringing
ongoingCall connected and active
Completed:
StatusDescription
user_hangupCaller hung up
agent_hangupAgent ended the call
inactivityTimeout due to inactivity
error_inactivityError during inactivity handling
Failed:
StatusDescription
busyLine was busy
no_answerNo answer after timeout
errorTechnical failure
canceledCall canceled before connecting
​
agent
object
Agent that handled the call. null if no agent assigned.
​
from_number
string
The caller’s phone number in E.164 format.
​
to_number
string
The called phone number in E.164 format.
​
direction
string
required
Call direction relative to the agent:
  • incoming - Call initiated TO the agent (inbound calls, web calls)
  • outgoing - Call initiated BY the agent (outbound calls via API)
​
start_timestamp
integer
Unix timestamp (milliseconds) when the call started.
​
duration_ms
integer
Call duration in milliseconds. null if call hasn’t ended.
​
transcript
array
Structured transcript with speaker roles and timestamps. null if no transcript.
​
detected_gender
string
Detected gender of the caller: male or female. null if not detected.
​
recording_url
string
Signed URL to the call recording. Expires in 1 hour. null if no recording.
​
summary
string
AI-generated summary of the call. null if not yet generated.
​
vars_provided
object
Variables provided when the call was created. Keys are variable names, values are strings.
​
vars_extracted
object
Variables extracted after the call by AI processing. Keys are variable names, values are strings.
​
vars_collected
object
Variables collected during the call in real-time by the agent (e.g., via Collection nodes). Keys are variable names, values are strings.

​
Example

{
  "call_id": "550e8400-e29b-41d4-a716-446655440000",
  "call_type": "phone_call",
  "call_status": "user_hangup",
  "agent": {
    "name": "Customer Support Agent",
    "version": 2
  },
  "from_number": "+15551234567",
  "to_number": "+15559876543",
  "direction": "outgoing",
  "start_timestamp": 1704067200000,
  "duration_ms": 120000,
  "transcript": [
    {
      "role": "agent",
      "content": "Hello, how can I help you?",
      "timestamp_ms": 0
    },
    {
      "role": "caller",
      "content": "I need help with my order",
      "timestamp_ms": 2500
    }
  ],
  "detected_gender": "male",
  "recording_url": "https://storage.voicy.co/recordings/...",
  "summary": "Customer inquiry about order status.",
  "vars_provided": {
    "customer_name": "John"
  },
  "vars_extracted": {
    "appointment_date": "2026-01-15"
  },
  "vars_collected": {
    "preferred_time": "morning"
  }
}