Call Get

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

{
  "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": "system",
      "content": "קריאה לפונקציה: lookup_order",
      "timestamp_ms": 3100,
      "function_invocation": {
        "invocation_id": "9a3e7c1d-4f62-4e3a-b0a8-0d3f8a1c2e11",
        "node_name": "lookup_order",
        "method": "POST",
        "url": "https://crm.example.com/api/orders/lookup",
        "request_body": { "customer_id": "CUST-12345" },
        "headers": { "Authorization": "[REDACTED]", "Content-Type": "application/json" }
      }
    },
    {
      "role": "system",
      "content": "תגובה מפונקציה: lookup_order",
      "timestamp_ms": 3342,
      "function_result": {
        "invocation_id": "9a3e7c1d-4f62-4e3a-b0a8-0d3f8a1c2e11",
        "node_name": "lookup_order",
        "status_code": 200,
        "response_body": { "status": "shipped", "tracking": "1Z999AA10123456784" },
        "extracted_vars": { "order_status": "shipped", "tracking_number": "1Z999AA10123456784" },
        "duration_ms": 242
      }
    },
    {
      "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"
  }
}

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"

{
  "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": "system",
      "content": "קריאה לפונקציה: lookup_order",
      "timestamp_ms": 3100,
      "function_invocation": {
        "invocation_id": "9a3e7c1d-4f62-4e3a-b0a8-0d3f8a1c2e11",
        "node_name": "lookup_order",
        "method": "POST",
        "url": "https://crm.example.com/api/orders/lookup",
        "request_body": { "customer_id": "CUST-12345" },
        "headers": { "Authorization": "[REDACTED]", "Content-Type": "application/json" }
      }
    },
    {
      "role": "system",
      "content": "תגובה מפונקציה: lookup_order",
      "timestamp_ms": 3342,
      "function_result": {
        "invocation_id": "9a3e7c1d-4f62-4e3a-b0a8-0d3f8a1c2e11",
        "node_name": "lookup_order",
        "status_code": 200,
        "response_body": { "status": "shipped", "tracking": "1Z999AA10123456784" },
        "extracted_vars": { "order_status": "shipped", "tracking_number": "1Z999AA10123456784" },
        "duration_ms": 242
      }
    },
    {
      "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"
  }
}

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

Path Parameters

call_id

string

required

The unique identifier of the call (UUID format).

Response

Returns a Call object with the following fields:

call_id

string

Unique call identifier (UUID)

call_type

string

phone_call or web_call

call_status

string

Current call status (see Call for values)

agent

object

Agent that handled the call.

Show Agent properties

name

string

Agent name

version

integer

Agent version used for this call

from_number

string

Caller’s phone number

to_number

string

Called phone number

direction

string

incoming or outgoing

start_timestamp

integer

Unix timestamp (ms) when the call started

duration_ms

integer

Call duration in milliseconds

transcript

array

Structured transcript. Each entry has:

Show Transcript entry properties

role

string

agent, caller, or system. system entries appear for flow-agent automation events — notably HTTP function-node calls, where one system turn carries a function_invocation payload (emitted when the request fires) and a subsequent system turn carries a function_result payload (emitted when the request completes). Consumers that only care about spoken dialogue can safely filter for role in [agent, caller].

content

string

What was said (or, for system entries, a Hebrew label like קריאה לפונקציה: <node_name>).

timestamp_ms

integer

Milliseconds from call start

function_invocation

object

Present on system entries that represent the start of an HTTP function-node call. Sensitive headers, URL basic-auth credentials, and known-sensitive query parameters (e.g. api_key, token) are redacted at capture time.

Show Function invocation properties

invocation_id

string

Stable ID correlating this invocation with its result entry

node_name

string

Flow-node display name that triggered the call

method

string

HTTP method (GET, POST, PATCH, PUT, DELETE)

url

string

Full request URL with secrets stripped/redacted

request_body

object

JSON body sent with the request, if any

headers

object

Request headers; sensitive values replaced with [REDACTED]

function_result

object

Present on system entries that represent the result of an HTTP function-node call.

Show Function result properties

invocation_id

string

Stable ID correlating this result with its invocation entry

node_name

string

Flow-node display name that triggered the call

status_code

integer

HTTP status code; 0 when the request never reached the server

response_body

object

Decoded JSON response body; may be raw bytes on bad-JSON failures

response_body_truncated

boolean

True if the server returned more than 1 MB and the body was truncated

response_headers

object

Response headers; sensitive values redacted

extracted_vars

object

Variables extracted from the response JSON per node configuration

duration_ms

integer

Request duration in milliseconds

error

string

Classified failure mode when the call didn’t succeed: timeout, ssrf_blocked, non_2xx, invalid_url, bad_response_json, type_validation_failed, or network. Omitted on success.

error_detail

string

Human-readable error detail

detected_gender

string

Detected gender of the caller (male or female)

recording_url

string

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

summary

string

AI-generated call summary

vars_provided

object

Variables provided when the call was created

vars_extracted

object

Variables extracted after the call by AI processing

vars_collected

object

Variables collected during the call in real-time by the agent

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

{
  "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": "system",
      "content": "קריאה לפונקציה: lookup_order",
      "timestamp_ms": 3100,
      "function_invocation": {
        "invocation_id": "9a3e7c1d-4f62-4e3a-b0a8-0d3f8a1c2e11",
        "node_name": "lookup_order",
        "method": "POST",
        "url": "https://crm.example.com/api/orders/lookup",
        "request_body": { "customer_id": "CUST-12345" },
        "headers": { "Authorization": "[REDACTED]", "Content-Type": "application/json" }
      }
    },
    {
      "role": "system",
      "content": "תגובה מפונקציה: lookup_order",
      "timestamp_ms": 3342,
      "function_result": {
        "invocation_id": "9a3e7c1d-4f62-4e3a-b0a8-0d3f8a1c2e11",
        "node_name": "lookup_order",
        "status_code": 200,
        "response_body": { "status": "shipped", "tracking": "1Z999AA10123456784" },
        "extracted_vars": { "order_status": "shipped", "tracking_number": "1Z999AA10123456784" },
        "duration_ms": 242
      }
    },
    {
      "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"
  }
}

Call Dial Call List

Overview

Models

Calls

Path Parameters

Response

Overview

Models

Calls

Documentation Index

​Path Parameters

​Response

Path Parameters

Response