Skip to main content
GET
Get Interaction Details

Authorizations

Authorization
string
header
required

Path Parameters

uuid
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
type
enum<string>
required

Identifies whether the interaction is a native call/conversation or an external-channel interaction.

Available options:
call,
conversation,
email,
sms,
external_channel
status
string
required
started_at
string<date-time> | null
required
created_at
string<date-time>
required

For native interactions this is the record creation time. For external-channel interactions this is the underlying session's ingestion time. Note: created_at sorting and the created_at_gte/created_at_lte filters order external-channel interactions by their call (leg start) time, not by this ingestion timestamp, so a returned created_at value may fall outside the requested filter window.

transcripts
(CallTranscriptResponse · object | ExternalChannelTranscriptResponse · object)[]
required

Transcript item shape depends on the interaction type.

modality
enum<string> | null

Native interactions return voice or text. External-channel interactions return null.

Available options:
voice,
text
language
enum<string>

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

Available options:
en,
es,
ar
from_number
string | null

Phone number for native interactions. External-channel interactions return null.

to_number
string | null

Phone number for native interactions. External-channel interactions return null.

transferred
boolean | null

Indicates if the interaction was transferred. External-channel interactions return null.

handoff_metadata
HandoffMetadata · object | null

Metadata about a transfer to an external provider.

direction
string | null

The direction of the interaction (inbound/outbound). External-channel interactions return null.

tags
Tags · object[]

Tags associated with the interaction

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

External identifiers associated with the interaction

params
Params · object | null

Parameters associated with the interaction

recording_presigned_url
string | null

Presigned URL for the recording (for voice modality only). External-channel interactions return null.

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
string | null

The summary of the interaction if available