GET
/
calls
/
{uuid}
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>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "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": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

uuid
string
required

Response

200
application/json
Successful Response
id
integer
required
simple_uuid
string
required
from_number
string
required
to_number
string
required
status
string
required
started_at
string | null
required
ended_at
string | null
required
duration
integer | null
required
created_at
string
required
prompt
object | null
required
transcripts
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
recording_presigned_url
string | null
analyzers
object[]

List of analyzers configured for this call

analysis_results
object[]

Results from analyzers that have completed