Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 4.62 KB

File metadata and controls

105 lines (73 loc) · 4.62 KB

CallRecord

One call on a number you own, either channel. channel tells you which lane it took: whatsapp (WhatsApp Business Calling) or pstn (a regular phone call). List endpoints omit transcript; use lastTranscriptSnippet for a preview and the detail endpoint for the full transcript.

Properties

Name Type Description Notes
id String [optional]
accountId String Owning social account. The unified /v1/calls/{id} detail + recording endpoints work for any channel; the channel-specific endpoints remain for account-scoped access. [optional]
conversationId String Inbox conversation with the counterparty, when one exists. [optional]
contactId String CRM Contact for the counterparty, when resolved. [optional]
channel ChannelEnum [optional]
direction DirectionEnum [optional]
from String Caller number (E.164). [optional]
to String Callee number (E.164). [optional]
forwardTo String Destination the call was routed to (tel:/sip:/wss:), snapshotted at routing time. [optional]
greeting String Outbound PSTN only. Message spoken to the callee on answer, before the bridge. [optional]
status StatusEnum [optional]
isVoicemail Boolean True when an inbound call went to voicemail. [optional]
amd Boolean Outbound answering-machine detection was requested for this call. [optional]
answeredMachine Boolean With `amd`, whether a machine (vs a human) answered. [optional]
forwardCallerId ForwardCallerIdEnum Caller ID presented on the forwarded leg. [optional]
recordingEnabled Boolean Effective flag for THIS call (number default + per-call override, resolved at create time). [optional]
transcriptionEnabled Boolean [optional]
transcriptionLanguage TranscriptionLanguageEnum [optional]
startedAt OffsetDateTime [optional]
answeredAt OffsetDateTime [optional]
endedAt OffsetDateTime [optional]
transferredAt OffsetDateTime When the call was blind-transferred (POST /v1/voice/calls/{id}/transfer). [optional]
durationSeconds Integer [optional]
endReason EndReasonEnum [optional]
hangupCause String Raw carrier hangup cause behind endReason (e.g. normal_clearing, not_found, time_limit) — the actual motive when endReason is a coarse bucket. [optional]
sipHangupCause String SIP response code that ended the call, when SIP-signalled (e.g. '403', '488'). The real failure reason for SIP legs. [optional]
callErrors List<CallRecordCallErrorsInner> Per-call failure log (dial failed, bridge failed, recording error). [optional]
recordingUrl String May be expired. Resolve a fresh playable URL via GET /v1/calls/{id}/recording (any channel). [optional]
lastTranscriptSnippet String Most recent transcript segment, for list previews. [optional]
transcript List<CallRecordTranscriptInner> Full transcript segments (detail endpoint only; omitted from lists). [optional]
billing CallRecordBilling [optional]
createdAt OffsetDateTime [optional]
updatedAt OffsetDateTime [optional]

Enum: ChannelEnum

Name Value
WHATSAPP "whatsapp"
PSTN "pstn"

Enum: DirectionEnum

Name Value
INBOUND "inbound"
OUTBOUND "outbound"

Enum: StatusEnum

Name Value
RINGING "ringing"
ANSWERED "answered"
ENDED "ended"
FAILED "failed"

Enum: ForwardCallerIdEnum

Name Value
BUSINESS "business"
CALLER "caller"

Enum: TranscriptionLanguageEnum

Name Value
AUTO "auto"
EN "en"
ES "es"

Enum: EndReasonEnum

Name Value
HANGUP "hangup"
NO_ANSWER "no_answer"
REJECTED "rejected"
ERROR "error"