Skip to main content
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
/
{conference_name}
/
Record
/
Start conference recording
curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "file_format": "mp3",
  "callback_url": "<string>"
}
'
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/
Start recording an active conference. The recording captures audio from all participants and can optionally generate a transcription. Once started, recording continues until explicitly stopped 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

ParameterTypeRequiredDescription
auth_idstringYesYour Vobiz account ID
conference_namestringYesName of the conference to record

​
Request parameters

FieldTypeRequiredDescription
file_formatstringNoRecording format. Values: mp3, wav. Default: mp3
callback_urlstringNoURL to receive the recording completion callback.

​
Example requests

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Record/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json"

​
Response

200 OK
{
  "message": "conference recording started",
  "api_id": "b0e8d7f2-58c4-11e1-86da-adf28403fe48",
  "recording_id": "rec_abc123def456",
  "url": "https://s3.amazonaws.com/recordings/rec_abc123def456.mp3"
}

​
Error responses

StatusMeaningHow to handle
401 UnauthorizedMissing/incorrect auth headers or a lowercase path.Use both auth headers and the PascalCase path.
404 Not FoundThe conference does not exist (no participant has joined the room yet).Conferences are created on join via the <Conference> XML element - start one before recording. URL-encode names with spaces.

​
Recording callback payload

When recording completes, your callback_url receives: 
{
  "conference_name": "MyConf",
  "recording_id": "rec_abc123def456",
  "recording_url": "https://s3.amazonaws.com/recordings/rec_abc123def456.mp3",
  "recording_duration": 1200,
  "file_format": "mp3"
}
Store the recording_id for future reference and download recordings to your own storage for long-term retention.

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

Recording started