Skip to main content
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
/
Record
Start recording a call
curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Record/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "time_limit": 120,
  "file_format": "mp3"
}
'
{
  "recording_id": "rec_XXXXXXXXXX",
  "message": "Recording started"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Record/
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 receive a callback when recording completes.
Transcription is available only in English, for calls between 500ms and 4 hours in duration, and under 2GB in file size.

​
Path parameters

ParameterTypeRequiredDescription
auth_idstringYesYour Vobiz authentication ID
call_uuidstringYesUnique identifier of the call to record

​
Request parameters

FieldTypeRequiredDescription
time_limitintegerNoMaximum recording duration in seconds. Default: 60. Increase for longer calls (e.g., 300, 900).
file_formatstringNoAudio format. Values: mp3, wav. Default: mp3
transcription_typestringNoSet to auto to enable automated transcription. Turnaround under 5 minutes.
transcription_urlstringNoURL to receive transcription data via HTTP POST
callback_urlstringNoURL invoked when recording ends with recording details
callback_methodstringNoHTTP method for callback_url. Values: GET, POST. Default: POST
record_channel_typestringNoRecording channel type. Values: mono, stereo. Default: mono
Use MP3 format for smaller file sizes. Stereo recording separates caller and callee into left/right channels for easier analysis.

​
Example requests

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

​
Response

202 Accepted
{
  "api_id": "uuid-here",
  "message": "recording started",
  "recording_id": "recording-uuid-here",
  "url": "https://recordings.example.com/recording-uuid.mp3"
}
FieldDescription
api_idUnique identifier for this API request
messageConfirmation that recording has started
recording_idUnique identifier for this recording
urlURL where the recording file will be available

​
Callback URL parameters

When recording ends, these fields are sent to your callback_url via HTTP POST:
FieldTypeDescription
api_idstringThe API ID returned by the Record API
record_urlstringURL where the recorded file can be accessed
call_uuidstringThe call UUID of the recorded call
recording_idstringUnique identifier for this recording
recording_durationintegerDuration of the recording in seconds
recording_duration_msintegerDuration of the recording in milliseconds
recording_start_msintegerStart time since epoch in milliseconds
recording_end_msintegerEnd time since epoch in milliseconds

​
Transcription callback parameters

When transcription completes, these fields are sent to your transcription_url:
FieldTypeDescription
transcription_chargenumberCredit deducted for the transcription
transcriptionstringThe transcribed text
durationintegerRecording duration in seconds
call_uuidstringThe call UUID that was transcribed
transcription_ratenumberRate of transcription per minute
recording_idstringRecording ID of the transcribed recording
errorstringError message if transcription failed; empty on success
If you see “Recording file size too large for transcription”, switch to mp3 format - MP3 files are significantly smaller than WAV.

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"

​
call_uuid
string
required
Example:

"cdr_XXXXXXXXXX"

Body

application/json
​
time_limit
integer
default:60
​
file_format
enum<string>
default:mp3
Available options:
mp3,
wav
​
transcription_type
string

Set to auto to enable transcription

​
callback_url
string
​
record_channel_type
enum<string>
default:mono
Available options:
mono,
stereo

Response

200 - application/json

Recording started