Every field and status of a voice session transcript
A voice session transcript is the redacted conversation of a voice session’s call, fetched from the voice provider each time you request it. To learn more, see Call log and transcripts.
Voice is in early access and subject to change. To request Voice access, contact hi@natural.com.
The object is everything inside data. The field names below are relative to it: attributes.status is data.attributes.status in the response.
Fields
string
required
Parent voice session ID (vos_*).
string
required
Resource type. Always voiceSessionTranscript.
object
required
The transcript’s details.
Hide attributes
string
required
Transcript availability. notAvailable when no call started. A missing provider link after call start is an error. One of: available, notAvailable. See Statuses.
object[]
required
Transcript turns in order. Empty when not available.
Hide turns
string
required
Speaker or an explicitly supported call event. One of: caller, assistant, system.
string
required
Redacted customer-facing dialogue or a supported system event label.
string | null
required
RFC 3339 timestamp of the turn, or null when unavailable.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Parent voice session.
Hide voiceSession
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always voiceSession.
string
required
Voice session ID (vos_*).
Statuses
Status
Meaning
Can become
available
A call started, and the transcript was fetched from the voice provider.
Final
notAvailable
No call has started for the session, or the call was simulated.