Call Sessions API Documentation & Reference

Manage active call sessions, lifecycle events, metadata, communication states, and voice interaction workflows.

Endpoints

MethodPathDescription
POST/callsStart an outbound call
GET/callsList call sessions
GET/calls/{id}Get call details
POST/calls/{id}/endEnd an active call
WS/calls/{id}/streamReal-time audio stream

Start Outbound Call

curl -X POST https://api.voxentis.com/v1/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "agt_9f2k4h1a",
    "to": "+14155551234",
    "metadata": {
      "campaign": "Q1-outreach",
      "lead_id": "lead_xyz"
    }
  }'

Call Status Lifecycle

StatusDescription
ringingCall is being placed, waiting for answer
in_progressCall is active, agent and caller are connected
transferringCall is being transferred to another party
completedCall ended normally
failedCall could not connect (busy, no answer, network error)
cancelledCall was ended before being answered

List Calls

NameTypeRequiredDescription
agent_idstringFilter by agent
statusstringFilter by call status
directionstring"inbound" or "outbound"
from_datestringStart date (ISO 8601)
to_datestringEnd date (ISO 8601)
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20)

End a Call

curl -X POST https://api.voxentis.com/v1/calls/call_7k3m9p2q/end \
  -H "Authorization: Bearer YOUR_API_KEY"

Inbound Calls

Inbound calls are created automatically when a caller dials a phone number assigned to one of your agents. Use the /phone-numbers endpoint to assign numbers to agents.