Transfer a live call
transfer_callBlind-transfer a live call leg to an E.164/SIP destination or custom VobizXML URL, replacing its current IVR, playback, or bridge flow. Requires confirmation.
Instructions
Blind-transfer a LIVE call (POST /Call/{uuid}/): Vobiz stops whatever the chosen leg is doing (IVR, playback, bridge) and fetches new VobizXML from the transfer URL. Give either destination (an E.164 number or sip: URI; this server hosts a flow for it, A leg only, HTTP mode with VOBIZ_PUBLIC_URL) or your own aleg_url / bleg_url on an approved host, never both. For an attended (warm) transfer build the flow with generate_answer_xml (hold music, then dial) and pass its URL. To park a leg use hold_call, to run a keypad menu on it use gather_dtmf, to end the call use end_call. A destination number must pass the server's destination policy and becomes a new, billed call leg; a call that is not live fails with call_not_active. Requires confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| legs | No | Leg to transfer: aleg (the call's first leg, default), bleg (the party bridged by <Dial>) or both. With `destination` only aleg is allowed. | |
| confirm | Yes | Must be true, set only after the user explicitly asked to transfer this call. If your client supports MCP elicitation, the server asks the user to approve directly and this flag is not relied on; otherwise it is your attestation that the user approved. | |
| aleg_url | No | https URL on an approved host that returns the VobizXML the A leg runs next. Required when legs is aleg or both and no destination is given. | |
| bleg_url | No | https URL on an approved host that returns the VobizXML the B leg runs next. Required when legs is bleg or both. | |
| call_uuid | Yes | UUID of the LIVE call to act on: the request_uuid returned by make_call, or a UUID from list_live_calls. | |
| caller_id | No | Caller ID the destination sees: an E.164 number on this account. Only used together with `destination`. | |
| aleg_method | No | HTTP method Vobiz uses to fetch aleg_url: GET or POST (default POST). | |
| bleg_method | No | HTTP method Vobiz uses to fetch bleg_url: GET or POST (default POST). | |
| destination | No | Where to connect the A leg: an E.164 number such as +14155550100, or sip:user@host. The server hosts the <Dial> flow (HTTP mode only). Not combinable with aleg_url/bleg_url. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| legs | No | The leg(s) the action was applied to (aleg when none was given). | |
| call_uuid | No | The call UUID the action was applied to, echoed from the request. | |
| http_status | No | HTTP status Vobiz answered with: 202 when an action was accepted, 204 when one was stopped. | |
| transferred | No | True once Vobiz accepted the transfer; the leg fetches and runs the new XML asynchronously. | |
| backend_message | No | Vobiz's own confirmation text for the request, or null when it sent none. |