GET
/
calls
/
{uuid}
Get Call Details
curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/calls/{uuid} \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record": true,
  "language": "en",
  "from_number": "<string>",
  "to_number": "<string>",
  "status": "<string>",
  "transferred": true,
  "direction": "<string>",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "color": "<string>"
    }
  ],
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "background_noise": "<string>",
  "agent_speaks_first": true,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "external_identifiers": {},
  "params": {},
  "prompt": {
    "prompt_text": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "transcripts": [
    {
      "text": "<string>",
      "role": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "function_name": "<string>",
      "arguments": {}
    }
  ],
  "recording_presigned_url": "<string>",
  "call_prompt": "<string>",
  "answered_by": "voicemail",
  "analyzers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "output_config": {
        "type": "string",
        "properties": {}
      }
    }
  ],
  "analysis_results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "output_config": {},
      "result": {}
    }
  ],
  "summary": {}
}

Authorizations

Authorization
string
header
required

Path Parameters

uuid
string<uuid>
required

Response

Successful Response

id
integer
required
simple_uuid
string<uuid>
required
from_number
string
required
to_number
string
required
status
string
required
started_at
string<date-time> | null
required
ended_at
string<date-time> | null
required
duration
integer | null
required
created_at
string<date-time>
required
prompt
object | null
required
transcripts
CallTranscriptResponse · object[]
required
call_prompt
string
required
answered_by
enum<string>
required

Indicates how the call was answered - by a human, voicemail, or if there was no answer

Available options:
voicemail,
human,
no_answer,
unknown
record
boolean
language
enum<string>

The language to use for the call - English (en) or Spanish (es)

Available options:
en,
es,
ar
transferred
boolean

Indicates if the call was transferred

direction
string

The direction of the call (inbound/outbound)

tags
Tags · object[]

Tags associated with the call

voice_id
string<uuid> | null

The ID of the voice used for the call

background_noise
string | null

The background noise setting for the call

agent_speaks_first
boolean | null

Whether the agent speaks first in the call

external_identifiers
object | null

External identifiers associated with the call

params
object | null

Parameters associated with the call

recording_presigned_url
string | null
analyzers
AnalyzerResponse · object[]

List of analyzers configured for this call

analysis_results
AnalysisResultResponse · object[]

Results from analyzers that have completed

summary
object | null

The summary of the call if available