Skip to main content

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.

You can use the <Record> and <Stream> elements together to simultaneously record a call and stream its audio to a WebSocket in real-time. This is useful for applications that require both persistent storage of the call audio and live processing, such as real-time transcription and analysis.

​
Stream with Record XML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Play>https://www.vobix.com/test/62801/play.wav</Play>
  <Record action="https://your-domain.com/record_action/" method="POST" maxLength="3600" playBeep="true">
    <Stream bidirectional="true" keepCallAlive="true">ws://sipp.voice.vobizdev.com:19092/ws</Stream>
  </Record>
  <Play>https://www.vobix.com/test/62801/play.wav</Play>
</Response>

​
Record Event Callback Parameters

The Record event will go to the callback URL once recording starts on the call. The recording will be accessible via media.vobiz.ai after the recording is complete.
ParameterTypeDescription
DigitsstringDigits pressed during the call.
FromstringThe calling party number.
RecordingIDstringThe unique ID for the recording.
RecordFilestringThe URL of the recorded file.
RecordingEndMsstringThe timestamp when the recording ended.
BillRatestringThe billing rate for the call.
TostringThe called party number.
RecordingDurationMsstringThe duration of the recording in milliseconds.
CallUUIDstringThe unique ID for the call.
ALegRequestUUIDstringThe request UUID for the A leg of the call.
SessionStartstringThe timestamp when the session started.
DirectionstringThe direction of the call (inbound or outbound).
RecordUrlstringThe URL of the recorded file.
RecordingDurationstringThe duration of the recording in seconds.
ALegUUIDstringThe unique ID for the A leg of the call.
CallStatusstringThe status of the call.
ParentAuthIDstringThe parent authentication ID.
RequestUUIDstringThe unique ID for the request.
EventstringThe event type (Record).
RecordingStartMsstringThe timestamp when the recording started.

​
Stream with Record & Callback URL XML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Play>https://www.vobix.com/test/62801/play.wav</Play>
  <Record action="https://your-domain.com/record_action/" method="POST" callbackUrl="https://your-domain.com/record_callback/" callbackMethod="POST" maxLength="3600" playBeep="true">
    <Stream bidirectional="true" keepCallAlive="true">ws://sipp.voice.vobizdev.com:19092/ws</Stream>
  </Record>
  <Play>https://www.vobix.com/test/62801/play.wav</Play>
</Response>

​
RecordStop Event Callback Parameters

A RecordStop event will be posted to the callbackUrl when the recording is stopped.
ParameterTypeDescription
FromstringThe calling party number.
RecordingIDstringThe unique ID for the recording.
RecordFilestringThe URL of the recorded file.
RecordingEndMsstringThe timestamp when the recording ended.
BillRatestringThe billing rate for the call.
TostringThe called party number.
RecordingDurationMsstringThe duration of the recording in milliseconds.
CallUUIDstringThe unique ID for the call.
ALegRequestUUIDstringThe request UUID for the A leg of the call.
SessionStartstringThe timestamp when the session started.
DirectionstringThe direction of the call (inbound or outbound).
RecordUrlstringThe URL of the recorded file.
RecordingDurationstringThe duration of the recording in seconds.
ALegUUIDstringThe unique ID for the A leg of the call.
CallStatusstringThe status of the call.
ParentAuthIDstringThe parent authentication ID.
RequestUUIDstringThe unique ID for the request.
EventstringThe event type (RecordStop).
RecordingStartMsstringThe timestamp when the recording started.