Start recording a conference
start_conference_recordingRecord a live Vobiz conference room's mixed audio in MP3 or WAV. Use when you need to capture a meeting; the recording file appears in list_recordings after the room ends.
Instructions
Start recording the mixed audio of a live Vobiz conference room (POST /Conference/{name}/Record/) in mp3 (default) or wav. Recording may require consent from every participant in your jurisdiction, so confirm with the user first (consider announcing it). Vobiz queues the recording; the reply carries no recording ID or file URL, and the file appears in list_recordings after the room ends. Stop with stop_conference_recording. Requires confirm: true. A room that is not running returns the not_found error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly asked to record this conference. | |
| file_format | No | Audio format of the file: mp3 (default, smaller) or wav (uncompressed). | |
| conference_name | Yes | Conference room name, exactly as used in the <Conference> XML element. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success; false when the result is an error (then error, message and retryable are set). | |
| note | No | Where to find the file later. | |
| recording | No | Always true: recording was queued. | |
| file_format | No | Format that will be produced: mp3 or wav. | |
| http_status | No | HTTP status Vobiz answered with (202 = accepted, 204 = done). | |
| backend_message | No | Vobiz's own status message, or null. | |
| conference_name | No | Room the action was applied to. |