GET
/
api
/
calls
/
{call_id}

Authorizations

X-API-Key
string
headerrequired

API key

Path Parameters

call_id
string
required

Response

200 - application/json
callId
string
required
clientVersion
string | null
required

The version of the client that joined this call.

created
string
required
ended
string | null
required
endReason
required

The reason the call ended.

  • unjoined - Client never joined
  • hangup - Client hung up
  • timeout - Call timed out
  • connection_error - Connection error
Available options:
unjoined,
hangup,
timeout,
connection_error
firstSpeaker
enum<string>
required

Who was supposed to talk first when the call started. Typically set to FIRST_SPEAKER_USER for outgoing calls and left as the default (FIRST_SPEAKER_AGENT) otherwise.

Available options:
FIRST_SPEAKER_AGENT,
FIRST_SPEAKER_USER
initialOutputMedium
enum<string>
required

The medium used initially by the agent. May later be changed by the client.

Available options:
MESSAGE_MEDIUM_VOICE,
MESSAGE_MEDIUM_TEXT
joinUrl
string | null
required
errorCount
integer
default: 0required

The number of errors in this call.

inactivityMessages
object[]

Messages spoken by the agent when the user is inactive for the specified duration. Durations are cumulative, so a message m > 1 with duration 30s will be spoken 30 seconds after message m-1.

joinTimeout
string
default: 30s
languageHint
string | null

BCP47 language code that may be used to guide speech recognition.

Maximum length: 16
maxDuration
string
default: 3600s
medium
object

Details about a call's protocol. By default, calls occur over WebRTC using the Ultravox client SDK. Setting a different call medium will prepare the server for a call using a different protocol. At most one call medium may be set.

model
string
default: fixie-ai/ultravox
recordingEnabled
boolean
default: false
systemPrompt
string | null
temperature
number
default: 0
Required range: 0 < x < 1
timeExceededMessage
string | null
voice
string | null
transcriptOptional
boolean
default: true

Indicates whether a transcript is optional for the call.

vadSettings
object

VAD settings for the call.