Start Recording a Call

Begin recording an active call with customizable format, transcription, and callback options.

This endpoint allows you to start recording a call that is currently in progress. You can create multiple recordings on the same call, customize the audio format, enable automated transcription, and configure callbacks to be notified when the recording is complete.

Important: Transcription is available only in English and limited to calls with duration between 500ms and 4 hours, and file size under 2GB.

HTTP Request

POSThttps://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Record/

Path Parameters

auth_idstringRequired

Your Vobiz authentication ID

call_uuidstringRequired

Unique identifier of the call to record

Request Parameters

Parameter	Type	Description
`time_limit`optional	integer	Maximum duration of the recording in seconds. If this parameter is not passed, the call recording duration is 60 seconds by default. If you need more time, you can set a higher limit like 300 seconds or 900 seconds according to your use case.
`file_format`optional	string	File format for the recording. Values: "mp3" or "wav". Default: "mp3"
`transcription_type`optional	string	Set to "auto" to enable automated transcription. Turnaround time is under 5 minutes.
`transcription_url`optional	string	URL to receive transcription data via HTTP POST callback.
`callback_url`optional	string	URL invoked when recording ends. Receives recording details via HTTP POST.
`callback_method`optional	string	HTTP method to invoke callback_url. Values: "GET" or "POST". Default: "POST"
`record_channel_type`optional	string	Recording channel type. Values: "mono" or "stereo". Default: "mono"

Recommendation: Use MP3 format for smaller file sizes. Stereo recording separates caller and callee into left/right channels for easier analysis.

Callback URL Parameters

When the recording ends, these parameters are sent to your callback_url via HTTP POST.

Parameters Sent to callback_url

Parameter	Type	Description
`api_id`optional	string	The API ID returned by the Record API
`record_url`optional	string	URL where the recorded file can be accessed
`call_uuid`optional	string	The call UUID of the recorded call
`recording_id`optional	string	Unique identifier for this recording
`recording_duration`optional	integer	Duration of the recording in seconds
`recording_duration_ms`optional	integer	Duration of the recording in milliseconds
`recording_start_ms`optional	integer	Start time of recording since epoch in milliseconds
`recording_end_ms`optional	integer	End time of recording since epoch in milliseconds

Transcription Callback Parameters

When transcription completes, these parameters are sent to your transcription_url via HTTP POST.

Parameters Sent to transcription_url

Parameter	Type	Description
`transcription_charge`optional	number	Credit deducted for the transcription
`transcription`optional	string	The transcribed text of the recording
`duration`optional	integer	Duration of the recording in seconds
`call_uuid`optional	string	The call UUID that was transcribed
`transcription_rate`optional	number	Rate of transcription per minute
`recording_id`optional	string	Recording ID of the transcribed recording
`error`optional	string	Error message if transcription failed (e.g., "Recording duration too long"). Empty if successful.

Note: .mp3 files are smaller than .wav files. Consider using MP3 format if you see "Recording file size too large for transcription" errors.

Response

Returns confirmation that recording has started along with a URL to access the recording.

Response - 202 Accepted

{
  "api_id": "uuid-here",
  "message": "recording started",
  "recording_id": "recording-uuid-here",
  "url": "https://recordings.example.com/recording-uuid.mp3"
}

Response Fields

api_id - Unique identifier for this API request

message - Confirmation message

recording_id - Unique identifier for this recording

url - URL where the recording file will be available

Example Request

Basic Recording

Request Body

{
  "time_limit": 120,
  "file_format": "mp3"
}

Recording with Transcription

Request Body

{
  "time_limit": 60,
  "file_format": "mp3",
  "callback_url": "https://example.com/recording_callback",
  "callback_method": "POST"
}

Stereo Recording

cURL Example

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Record/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "time_limit": 60,
    "file_format": "mp3"
  }'

Note on Recording Duration: If the time_limit parameter is not passed, the call recording duration is 60 seconds by default. If you need more time, you can define a higher limit like 300, 900, or more seconds according to your specific use case.

Use Cases

•Record customer service calls for quality assurance
•Create transcripts for compliance and legal documentation
•Capture agent-customer interactions for training
•Record specific call segments (e.g., after IVR)
•Archive important business conversations

Record Calls Overview

Stop Recording