Start recording a live call
start_recordingRecords a live call to one mp3/wav file, mixed or per-party, ending at a set time, hangup, or manual stop; the file is then available for retrieval.
Instructions
Start recording a LIVE call (POST /Call/{uuid}/Record/) into one file, either mixed (mono, default) or one party per channel (stereo). Recording ends at time_limit seconds (default 60, max 8 hours), when the call hangs up, or with stop_recording; the file then appears in get_call_recording / list_recordings and its storage is billed. Playback and speech on the call (play_audio, speak_text) are unaffected; to capture only a caller's answer inside an IVR use the record action of generate_answer_xml instead. Recording may require consent from the other party in your jurisdiction, so confirm with the user first. Requires confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly asked to record 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. | |
| 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. | |
| time_limit | No | Maximum seconds to record, 1-28800 (default 60). The recording also ends when the call does. | |
| file_format | No | Audio format of the file: mp3 (default) or wav. | |
| record_channel_type | No | mono (default): both parties mixed into one channel; stereo: each party on its own channel. |
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`. | |
| url | No | URL of the recording file as Vobiz reports it; pass it to stop_recording to stop just this recording. Null when not reported. | |
| note | No | Reminder that the file is only retrievable (get_call_recording) after the recording stops. | |
| call_uuid | No | The call UUID the action was applied to, echoed from the request. | |
| recording | No | True once Vobiz accepted the request and started recording. | |
| http_status | No | HTTP status Vobiz answered with: 202 when an action was accepted, 204 when one was stopped. | |
| recording_id | No | Identifier Vobiz assigned to this recording, or null when it did not report one. | |
| backend_message | No | Vobiz's own confirmation text for the request, or null when it sent none. |