Skip to main content
GET
/
interactions
/
{uuid}
Get Interaction Details
curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/interactions/{uuid} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modality": "voice",
  "status": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "transcripts": [
    {
      "text": "<string>",
      "role": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "function_name": "<string>",
      "arguments": {}
    }
  ],
  "language": "en",
  "from_number": "<string>",
  "to_number": "<string>",
  "transferred": true,
  "direction": "<string>",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "color": "<string>"
    }
  ],
  "ended_at": "2023-11-07T05:31:56Z",
  "duration": 123,
  "external_identifiers": {},
  "params": {},
  "recording_presigned_url": "<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
string<uuid>
required
modality
enum<string>
required

The modality of the interaction - voice calls or text conversations

Available options:
voice,
text
status
string
required
started_at
string<date-time> | null
required
created_at
string<date-time>
required
transcripts
CallTranscriptResponse · object[]
required
language
enum<string>

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

Available options:
en,
es,
ar
from_number
string | null
to_number
string | null
transferred
boolean | null

Indicates if the interaction was transferred

direction
string | null

The direction of the interaction (inbound/outbound)

tags
Tags · object[]

Tags associated with the interaction

ended_at
string<date-time> | null
duration
integer | null
external_identifiers
External Identifiers · object

External identifiers associated with the interaction

params
Params · object

Parameters associated with the interaction

recording_presigned_url
string | null

Presigned URL for the recording (for voice modality only)

answered_by
enum<string> | null

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

Available options:
voicemail,
human,
no_answer,
unknown
analyzers
AnalyzerResponse · object[]

List of analyzers configured for this interaction

analysis_results
AnalysisResultResponse · object[]

Results from analyzers that have completed

summary
Summary · object

The summary of the interaction if available