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
| Field | Type | Required | Description |
|---|---|---|---|
call_id | CallId | yes | |
command_id | ControlCommandId or null | yes | The control command, for source control. |
context_note | string or null | yes | Why 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_status | ContextNoteStatus | yes | |
destination | TransferDestinationKey | yes | |
ended_at | Timestamp | yes | When the outcome was known. |
failure_code | TransferFailureCode or null | yes | On a failure, why; null otherwise. |
mode | TransferMode | yes | |
object | "call_transfer" | yes | |
outcome | TransferOutcome or null | yes | How the attempt ended; null on transfer.started. |
policy_id | PolicyId or null | yes | The Policy, for source policy. |
policy_version | integer or null | yes | The Policy version that fired, for source policy. |
refer_sent_at | Timestamp or null | yes | When the REFER was sent; null on a refusal. |
refusal_reason | TransferRefusalReason or null | yes | On a refusal, why; null otherwise. |
requested_at | Timestamp | yes | |
sip_status | integer or null | yes | The final SIP status of the REFER when one came; null otherwise. |
source | TransferSource | yes | |
transfer_id | TransferId | yes | |
turn_seq | integer or null | yes | The 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.