VocalDocscontracts 1.65.0

CallTransfer

One transfer attempt of a Call with its context note (1.50.0), as the api stored it at finalize; the receiving team reads the note so the caller need not repeat it.

An object with 19 fields.

Fields

FieldTypeRequiredDescription
call_idCallIdyes
command_idControlCommandId or nullyesThe control command, for source control.
context_notestring or nullyesWhy the caller was transferred and what was established, written by the Agent before the REFER (FR-telephony-6); null unless context_note_status is written. Content: redacted like the transcript's final text, encrypted at rest, and read only with transcripts:read as an audited content read.
context_note_statusContextNoteStatusyes
destinationTransferDestinationKeyyes
ended_atTimestampyesWhen the outcome was known.
failure_codeTransferFailureCode or nullyesOn a failure, why; null otherwise.
modeTransferModeyes
object"call_transfer"yes
outcomeTransferOutcome or nullyesHow the attempt ended; null on transfer.started.
policy_idPolicyId or nullyesThe Policy, for source policy.
policy_versioninteger or nullyesThe Policy version that fired, for source policy.
refer_sent_atTimestamp or nullyesWhen the REFER was sent; null on a refusal.
refusal_reasonTransferRefusalReason or nullyesOn a refusal, why; null otherwise.
requested_atTimestampyes
sip_statusinteger or nullyesThe final SIP status of the REFER when one came; null otherwise.
sourceTransferSourceyes
transfer_idTransferIdyes
turn_seqinteger or nullyesThe seq of the Turn the request came in; null outside every Turn.

Used by

The operations whose parameters, request body or responses name this shape directly.