Skip to main content
POST
/
v1
/
call-dial
curl -X POST https://api.voicy.co/functions/v1/call-dial \
  -H "Authorization: Bearer voicy_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "from_number": "+15551234567",
    "to_number": "+15559876543",
    "vars_provided": {
      "customer_name": "John"
    }
  }'
{
  "call_id": "550e8400-e29b-41d4-a716-446655440000",
  "call_status": "initiated",
  "call_type": "phone_call",
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "from_number": "+15551234567",
  "to_number": "+15559876543",
  "direction": "outgoing"
}

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.

Initiate an outbound phone call via Twilio. The call will be handled by the AI agent assigned to the specified phone number.

Request Body

from_number
string
required
Your Twilio phone number in E.164 format (e.g., +15551234567). Must be assigned to your account.
to_number
string
required
The destination phone number in E.164 format (e.g., +15559876543).
override_agent_id
string
Optional UUID of an agent to use instead of the default agent assigned to the phone number.
vars_provided
object
Optional key-value pairs that will be injected into the agent’s system prompt. Useful for personalizing calls.
{
  "customer_name": "John",
  "appointment_date": "January 15th"
}

Response

call_id
string
Unique identifier for the call (UUID format).
call_status
string
Current status of the call. Will be initiated immediately after creation. Poll /v1/call-get/{call_id} to track status changes:
  • initiatedringingongoingended (successful call)
  • initiatedringingbusy (recipient busy)
  • initiatedringingno_answer (no pickup)
  • initiatederror (technical failure)
call_type
string
Always phone_call for phone calls.
agent_id
string
ID of the agent handling the call.
from_number
string
The caller ID phone number.
to_number
string
The destination phone number.
direction
string
Always outgoing for calls created via API.
curl -X POST https://api.voicy.co/functions/v1/call-dial \
  -H "Authorization: Bearer voicy_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "from_number": "+15551234567",
    "to_number": "+15559876543",
    "vars_provided": {
      "customer_name": "John"
    }
  }'
{
  "call_id": "550e8400-e29b-41d4-a716-446655440000",
  "call_status": "initiated",
  "call_type": "phone_call",
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "from_number": "+15551234567",
  "to_number": "+15559876543",
  "direction": "outgoing"
}