Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Recording

Start Conference Recording

Begin recording a conference call with customizable settings and optional transcription.

This API allows you to start recording an active conference. The recording will capture audio from all participants and can optionally generate a transcription.

Authentication Required:

  • • X-Auth-ID: Your account ID (e.g., {Auth_ID})
  • • X-Auth-Token: Your account Auth Token
  • • Content-Type: application/json

Recording Behavior: Once started, the recording continues until explicitly stopped or until the conference ends. Multiple start requests will return an error if recording is already active.

Legal Notice: Ensure you comply with local recording consent laws. Consider playing an announcement to participants before starting the recording.

HTTP Request

POSThttps://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/

Request Parameters

Request Parameters

NameTypeDescription
file_format
stringFormat of the recording file. Options: mp3, wav. Default: mp3.
recording_callback_url
stringURL where recording completion callback will be sent when the recording is ready.
recording_callback_method
stringHTTP method for recording callback. Options: POST, GET. Default: POST.

Response

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"
}

Examples

Start Basic Recording

cURL Request
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"

Start Recording with WAV Format

cURL Request
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" \
  -d '{"file_format":"wav"}'

Start Recording with Callback

cURL Request
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" \
  -d '{
    "file_format": "mp3",
    "recording_callback_url": "https://yourserver.com/recording-complete",
    "recording_callback_method": "POST"
  }'

Recording Callback:

When recording completes, your callback URL will receive a notification with the recording details:

Recording Callback Payload
{
  "conference_name": "MyConf",
  "recording_id": "rec_abc123def456",
  "recording_url": "https://s3.amazonaws.com/recordings/rec_abc123def456.mp3",
  "recording_duration": 1200,
  "file_format": "mp3"
}

Best Practices:

  • • Store the recording_id for later retrieval
  • • Use WAV for archival quality, MP3 for smaller file sizes
  • • Secure your transcription callback URL with authentication
  • • Download recordings to your own storage for long-term retention
Conference Recording Overview
Stop Recording