Skip to main content
POST
/
v1
/
outbound
/
retrieve-call
Retrieve a call
curl --request POST \
  --url https://api.cozmox.cloud/v1/outbound/retrieve-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "callId": "1234567890"
}
'
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "call_status": "completed",
  "initialContext": "Hello, how are you?",
  "greeting": "Hello, how are you?",
  "fromPhone": "+1234567890",
  "disconnect_reason": "<string>",
  "extraContext": {
    "name": "Liza",
    "current_datetime": "2025-01-01 10:10:10"
  },
  "agent": {
    "id": "<string>",
    "name": "<string>",
    "editedAt": "2023-11-07T05:31:56Z",
    "latestPrompt": "<string>",
    "primaryKnowledge": "<string>",
    "backgroundNoise": "<string>",
    "backgroundNoiseVolume": 1.05,
    "llmProvider": "<string>",
    "llmModel": "<string>",
    "greeting": "<string>",
    "stt": "<string>",
    "tts": "<string>",
    "baseLanguage": "<string>",
    "voiceId": "<string>",
    "voiceName": "<string>",
    "backchannelingFrequency": 123,
    "backchannelingWords": "<string>",
    "tools": [
      {
        "name": "<string>",
        "webhook_url": "<string>",
        "description": "<string>",
        "api_timeout_ms": 123,
        "speak_during_execution": true,
        "speak_after_execution": true,
        "parameters": {
          "type": "<string>",
          "properties": {},
          "required": [
            "<string>"
          ]
        }
      }
    ]
  },
  "summary": "<string>",
  "analysis": {
    "needs_callback": "yes"
  },
  "call_duration": 123,
  "recording_url": "<string>",
  "is_voicemail": true
}

Authorizations

x-api-key
string
header
required

The API key

Body

application/json
callId
string
required

The call id

Example:

"1234567890"

Response

createdAt
string<date-time>
required

The date and time the call was created

Example:

"2025-01-01T00:00:00.000Z"

call_status
string
required

The status of the call

Example:

"completed"

initialContext
string
required

The initial context of the call

Example:

"Hello, how are you?"

greeting
string
required

The greeting of the call

Example:

"Hello, how are you?"

fromPhone
string
required

The phone number of the caller

Example:

"+1234567890"

disconnect_reason
string
required

The disconnect reason of the call

extraContext
object
required

The extra variables of the call

Example:
{
"name": "Liza",
"current_datetime": "2025-01-01 10:10:10"
}
agent
object
required

The agent of the call

summary
string
required

The summary of the call

analysis
object
required

The analysis fields of the call

Example:
{ "needs_callback": "yes" }
call_duration
number
required

The duration of the call

recording_url
string
required

The recording url of the call

is_voicemail
boolean
required

Whether the call is voicemail