Overview
The Calls API handles two distinct call modes:- Web calls — real-time audio over WebSocket, initiated from a browser or server
- Phone calls — outbound calls to a real phone number via a purchased Indigenius number
calls:read (read), calls:write (initiate)
GET /v1/calls
Lists all calls for your organization.
200 OK
403 missing calls:read scope
POST /v1/calls/initiate
Creates a web call session. Returns a WebSocket URL that your client connects to for real-time audio.
201 Created
gateway.url to begin the real-time session. Save callId to retrieve the transcript and analysis after the call ends.
Common errors: 400 invalid payload · 403 missing calls:write scope
POST /v1/calls/phone/initiate
Initiates an outbound phone call to a real number via your purchased Indigenius phone number.
400 invalid payload · 403 missing calls:write scope · 404 phone purchase not found
GET /v1/calls/{id}
Returns details for a specific call.
200 OK
403 missing calls:read scope · 404 call not found
GET /v1/calls/{id}/transcripts
Returns the full conversation transcript for a call.
200 OK
GET /v1/calls/{id}/analysis
Returns AI-generated post-call analysis including summary, sentiment, and tags.
200 OK
403 missing calls:read scope · 404 call not found