Skip to main content
GET
A light read meant for polling while a call runs, for example to show a live call in your own interface. It answers in a few fields and never carries the transcript. finished turns true seconds after the hang-up. The analysis, the recording and the transcript arrive later: read them with Get Call once the call is finished. To hang up from your interface, use Stop Call.

Path Parameters

string
requerido
The UUID of the call, as returned by Make AI Phone Call.

Headers

string
requerido
Your API key for authentication. Found in your dashboard under API settings.

Response

The response is { "statusCode": number, "data": object }. The fields below describe data.
string
The UUID of the call.
string
The agent placing the call.
string
Where the call is: in_queue or scheduled before it is placed, pending while it rings, in_progress once answered, and ended, voicemail, no_answer, failed or canceled when it is over.
boolean
Whether the call is over.
string
Why the call ended, e.g. user_hangup or agent_hangup. It can stay null for a few seconds after finished turns true.
string
When the call was answered (ISO 8601), or null.
string
When the call ended (ISO 8601), or null.

Error Codes

  • 400 Bad Request — callId is not a valid UUID
  • 401 Unauthorized — Invalid or missing API key
  • 404 Not Found — Call not found or does not belong to your organization
  • 429 Too Many Requests — Poll every few seconds, not in a tight loop. See Rate limits

Code Examples