Skip to main content

Calls

Get call

Retrieves the full detail of a single call by its uid, including the conversation transcript and a link to the recording.

Authentication​

AuthorizationBearer

Authenticate server-side requests with a Fonema API key. Create one in the API keys section of the Dashboard and send it in the Authorization header as Bearer <token>. Keep keys out of client-side code and public repositories.

Path parameters​

uidstringRequired

Unique identifier of the call. Get it from List calls or from the end-of-call webhook.

Response​

uidstring
Unique call identifier.
agentobject
The agent that handled the call (name and slug).
toNumberstring
Phone number that was called, in E.164 format.
endedReasonstring
Why the call ended (e.g. customer-ended-call, voicemail).
createdAtstring
When the call was created (queued).
startAtstring | null
When the call was answered. null if it never connected.
endAtstring | null
When the call ended.
durationSecondsinteger
Call duration in seconds. 0 if the call never connected.
successEvaluationboolean
Whether the call met the agent's success criteria.
inputDataobject
The variables provided when the call was created.
outputDataobject

End-of-call results: summary, successEvaluation, and any output variables captured by the agent.

transcriptarray

Conversation transcript, ordered by time. Each entry has role (agent or user), content, and secondsFromStart.

audioUrlstring | null

Path to the call recording, relative to https://api.fonema.ai. null if no recording is available.

Download the recording​

The recording endpoint accepts the same API key:

GET /v1/calls/:uid/audio.mp3

curl -X GET "https://api.fonema.ai/v1/calls/aBcDeFgHiJkL/audio.mp3" \
-H "Authorization: Bearer YOUR_API_KEY_HERE" \
-o recording.mp3

Errors​

404
Call not found or not accessible by this API key.