Skip to main content
POST
Start conference recording
Start recording an active conference. The recording captures conference audio and continues until you stop it or the conference ends.
Legal notice - Ensure you comply with local recording consent laws. Consider playing an announcement to participants before starting the recording.

Path parameters

Request parameters

Example requests

Response

200 OK
The response confirms that Vobiz queued the recording operation. It does not include a recording ID or download URL.

Error responses

Recording callback

Treat callback_url as an optional notification. To get a recording file with its ID and URL, use per-leg session recording with <Record recordSession="true">.
Use Stop Conference Recording to stop the active recording. The start response confirms the request.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

conference_name
string
required

Body

application/json
file_format
enum<string>
default:mp3
Available options:
mp3,
wav
callback_url
string

Response

200 - application/json

Recording request queued