Call Get

curl https://api.voicy.co/functions/v1/call-get/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer voicy_sk_live_xxx"

const callId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(`https://api.voicy.co/functions/v1/call-get/${callId}`, {
  headers: {
    'Authorization': 'Bearer voicy_sk_live_xxx',
  },
});

const call = await response.json();

// Access collected variables (gathered during the call via Collection nodes)
const varsCollected = call.vars_collected; // e.g., { "preferred_time": "morning" }

// Access extracted variables (generated after the call by AI processing)
const varsExtracted = call.vars_extracted; // e.g., { "appointment_date": "2026-01-15" }

import requests

call_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
    f'https://api.voicy.co/functions/v1/call-get/{call_id}',
    headers={
        'Authorization': 'Bearer voicy_sk_live_xxx',
    },
)

call = response.json()

# Access collected variables (gathered during the call via Collection nodes)
vars_collected = call.get('vars_collected', {})  # e.g., {"preferred_time": "morning"}

# Access extracted variables (generated after the call by AI processing)
vars_extracted = call.get('vars_extracted', {})  # e.g., {"appointment_date": "2026-01-15"}

{
  "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": "Can you look up my order?",
      "timestamp_ms": 2500
    },
    {
      "role": "agent",
      "content": "Your order has shipped — tracking 1Z999AA10123456784.",
      "timestamp_ms": 3500
    }
  ],
  "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",
    "products": [
      { "code": 1042, "qty": 3, "product_name": "חמאה", "price": 12.5 },
      { "code": 8810, "qty": 2, "product_name": "חלב", "price": 6.9 }
    ]
  }
}

{
  "error": "Call not found"
}

GET

call-get

{call_id}

curl https://api.voicy.co/functions/v1/call-get/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer voicy_sk_live_xxx"

const callId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(`https://api.voicy.co/functions/v1/call-get/${callId}`, {
  headers: {
    'Authorization': 'Bearer voicy_sk_live_xxx',
  },
});

const call = await response.json();

// Access collected variables (gathered during the call via Collection nodes)
const varsCollected = call.vars_collected; // e.g., { "preferred_time": "morning" }

// Access extracted variables (generated after the call by AI processing)
const varsExtracted = call.vars_extracted; // e.g., { "appointment_date": "2026-01-15" }

import requests

call_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
    f'https://api.voicy.co/functions/v1/call-get/{call_id}',
    headers={
        'Authorization': 'Bearer voicy_sk_live_xxx',
    },
)

call = response.json()

# Access collected variables (gathered during the call via Collection nodes)
vars_collected = call.get('vars_collected', {})  # e.g., {"preferred_time": "morning"}

# Access extracted variables (generated after the call by AI processing)
vars_extracted = call.get('vars_extracted', {})  # e.g., {"appointment_date": "2026-01-15"}

{
  "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": "Can you look up my order?",
      "timestamp_ms": 2500
    },
    {
      "role": "agent",
      "content": "Your order has shipped — tracking 1Z999AA10123456784.",
      "timestamp_ms": 3500
    }
  ],
  "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",
    "products": [
      { "code": 1042, "qty": 3, "product_name": "חמאה", "price": 12.5 },
      { "code": 8810, "qty": 2, "product_name": "חלב", "price": 6.9 }
    ]
  }
}

{
  "error": "Call not found"
}

Retrieve complete details for a call, including transcript, recording URL, and summary.

Path Parameters

string

required

The unique identifier of the call (UUID format).

Response

Returns a Call object with the following fields:

string

Unique call identifier (UUID)

string

phone_call or web_call

string

Current call status (see Call for values)

string

Why the call never connected — no_answer, busy, declined, not_in_service, carrier_rejected or failed; null once connected (see Call)

object

Agent that handled the call.

Show Agent properties

string

Agent name

integer

Agent version used for this call

string

Caller’s phone number

string

Called phone number

string

incoming or outgoing

integer

Unix timestamp (ms) when the call started

integer

Call duration in milliseconds

array

Structured transcript. Each entry has:

Show Transcript entry properties

string

agent, caller, or system. agent and caller are spoken turns. system entries mark flow-agent automation events (e.g. a function-node call or a flow-state change). Consumers that only care about spoken dialogue can safely filter for role in [agent, caller].

string

What was said (for system entries, a short event label).

integer

Milliseconds from call start

string

Detected gender of the caller (male or female)

string

Signed URL to the call recording (expires in 1 hour)

string

AI-generated call summary

object

Variables provided when the call was created

object

Variables extracted after the call by AI processing

object

Variables collected during the call in real-time by the agent. Each value is either a string (single-value var, populated by Collection or Set Var nodes) or an array of objects (list var, populated by a List node — each array entry is one item bundled from the var names declared in the node’s item schema). Consumers should check the runtime type per key.Variable names beginning with _ (e.g. _temp) are call-local: they are usable during the call but stripped before persistence and never returned in this field.

boolean

Whether this call was made by a test user contact

curl https://api.voicy.co/functions/v1/call-get/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer voicy_sk_live_xxx"

const callId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(`https://api.voicy.co/functions/v1/call-get/${callId}`, {
  headers: {
    'Authorization': 'Bearer voicy_sk_live_xxx',
  },
});

const call = await response.json();

// Access collected variables (gathered during the call via Collection nodes)
const varsCollected = call.vars_collected; // e.g., { "preferred_time": "morning" }

// Access extracted variables (generated after the call by AI processing)
const varsExtracted = call.vars_extracted; // e.g., { "appointment_date": "2026-01-15" }

import requests

call_id = '550e8400-e29b-41d4-a716-446655440000'
response = requests.get(
    f'https://api.voicy.co/functions/v1/call-get/{call_id}',
    headers={
        'Authorization': 'Bearer voicy_sk_live_xxx',
    },
)

call = response.json()

# Access collected variables (gathered during the call via Collection nodes)
vars_collected = call.get('vars_collected', {})  # e.g., {"preferred_time": "morning"}

# Access extracted variables (generated after the call by AI processing)
vars_extracted = call.get('vars_extracted', {})  # e.g., {"appointment_date": "2026-01-15"}

{
  "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": "Can you look up my order?",
      "timestamp_ms": 2500
    },
    {
      "role": "agent",
      "content": "Your order has shipped — tracking 1Z999AA10123456784.",
      "timestamp_ms": 3500
    }
  ],
  "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",
    "products": [
      { "code": 1042, "qty": 3, "product_name": "חמאה", "price": 12.5 },
      { "code": 8810, "qty": 2, "product_name": "חלב", "price": 6.9 }
    ]
  }
}

{
  "error": "Call not found"
}

Overview

Models

Calls

Agents

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response