Resume a held call
unhold_callTake a live call leg off hold by transferring it to an approved VobizXML resume URL that controls the next step. Requires confirmation; use only after hold_call.
Instructions
Take a leg of a LIVE call off emulated hold by transferring it to resume_url (VobizXML on an approved host, for example a hosted flow from generate_answer_xml or the url from gather_dtmf). Vobiz cannot return to the point the call was at before hold_call, so the resume XML decides what happens next (speak, dial the other party again, a menu). To end the call instead use end_call. Only meaningful after hold_call; a call that is not live fails with call_not_active. Requires confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| legs | No | Leg to resume: the same value given to hold_call (default aleg). | |
| confirm | Yes | Must be true, set only after the user explicitly asked to take this call off hold. 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. | |
| 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. | |
| resume_url | Yes | https URL on an approved host returning the VobizXML that controls the leg after hold. |
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). | |
| on_hold | No | False once Vobiz accepted the transfer to resume_url. | |
| emulated | No | Always true: hold and resume are transfers between hosted flows, not a native Vobiz hold. | |
| 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. |