Hang up a call
end_callTerminate an active or queued call for all parties after explicit user confirmation. Requires call_uuid and confirm: true.
Instructions
Terminate an active or queued call (DELETE /Account/{auth_id}/Call/{call_uuid}/) for every party on it. Checks first that the call is live or queued on this account. To move the call elsewhere instead use transfer_call; to park a leg use hold_call. Required: call_uuid and confirm: true after the user explicitly asked to end this call. Fails with call_not_active if the call already ended and not_found if no such call exists on the account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly asked to end this call. | |
| call_uuid | Yes | UUID of the call to end: the request_uuid from make_call, or a UUID from list_live_calls. |
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`. | |
| note | No | Where the final record will appear (get_call_details). | |
| call_uuid | No | The call UUID the request was about, echoed back. | |
| terminated | No | True once Vobiz accepted the hangup. | |
| http_status | No | HTTP status Vobiz answered with. | |
| previous_state | No | Whether the call was in progress or still waiting to be dialed when it was ended. |