Stream with Record

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

Stream with Record
<Response>
  <Play>https://www.vobix.com/test/62801/play.wav</Play>
  <Record action="http://vobiz-callback/api/v1/test.xml" redirect="false" recordSession="true" maxLength="3600"/>
  <Stream streamTimeout="10" contentType="audio/x-l16;rate=16000" keepCallAlive="true" bidirectional="true">ws://sipp.voice.vobizdev.com:19092/ws</Stream>
  <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.

ParameterDescription
DigitsDigits pressed during the call.
FromThe calling party number.
RecordingIDThe unique ID for the recording.
RecordFileThe URL of the recorded file.
RecordingEndMsThe timestamp when the recording ended.
BillRateThe billing rate for the call.
ToThe called party number.
RecordingDurationMsThe duration of the recording in milliseconds.
CallUUIDThe unique ID for the call.
ALegRequestUUIDThe request UUID for the A leg of the call.
SessionStartThe timestamp when the session started.
DirectionThe direction of the call (inbound or outbound).
RecordUrlThe URL of the recorded file.
RecordingDurationThe duration of the recording in seconds.
ALegUUIDThe unique ID for the A leg of the call.
CallStatusThe status of the call.
ParentAuthIDThe parent authentication ID.
RequestUUIDThe unique ID for the request.
EventThe event type (Record).
RecordingStartMsThe timestamp when the recording started.

Stream with Record & Callback URL XML

Stream with Record and Callback URL
<Response>
  <Play>https://www.vobix.com/test/62801/play.wav</Play>
  <Record callbackUrl="http://vobiz-callback/api/v1/test.xml"  action="http://vobiz-callback/api/v1/test.xml" redirect="false" recordSession="true" maxLength="3600"/>
  <Stream streamTimeout="10" contentType="audio/x-l16;rate=16000" keepCallAlive="true" bidirectional="true">ws://sipp.voice.vobizdev.com:19092/ws</Stream>
  <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.

ParameterDescription
FromThe calling party number.
RecordingIDThe unique ID for the recording.
RecordFileThe URL of the recorded file.
RecordingEndMsThe timestamp when the recording ended.
BillRateThe billing rate for the call.
ToThe called party number.
RecordingDurationMsThe duration of the recording in milliseconds.
CallUUIDThe unique ID for the call.
ALegRequestUUIDThe request UUID for the A leg of the call.
SessionStartThe timestamp when the session started.
DirectionThe direction of the call (inbound or outbound).
RecordUrlThe URL of the recorded file.
RecordingDurationThe duration of the recording in seconds.
ALegUUIDThe unique ID for the A leg of the call.
CallStatusThe status of the call.
ParentAuthIDThe parent authentication ID.
RequestUUIDThe unique ID for the request.
EventThe event type (RecordStop).
RecordingStartMsThe timestamp when the recording started.