Record Module

The Record module will record a sound file.

The Record module can also be used to do Call Recording. It can be used to record the conversation between two callers connected together using "Dial and Conference" (tromboned transfer) or 3-way-call. For more information see here.

Recording will finish when:

  • a user settable timeout is reached, or
  • a key that has a path defined for it is pressed, or
  • silence is detected, or
  • if the caller hangs up.

In the ‘Record file details’ text box you may:

Specify the full filename of the destination file:
Recording will be copied to the specified destination. If a file with this name exists already then it will be overwritten.

Specify just the directory in which the recordings are to be placed
A filename will be generated and the recording will be placed in the specified directory. The directory name must finish with a “\

Leavethe entry blank
A filename will be generated and the recording will be placed in the script’s directory

If the destination filename is not specified the following file name will be generated by VoiceGuide:



MM 2 digit month
DD 2 digit day
HH 2 digit hour
NN 2 digit minute
SS 2 digit second
LineId on which line the call arrived
CallerID Caller ID of the caller who left the message

The record module is usually used to allow remote recording of a file which is used by other parts of a script or other scripts. For messages left by callers a Voicemail box is usually used.


The Timeout path is used to specify the maximum length of recording.

The paths screen below shows that the recording can go on for 30 seconds, after which the caller will be sent to the Main Welcome module. If the caller presses any of the keys listed, the recording will terminate and the caller will be sent to the Main Welcome module.


Silence Detection

The recording will also stop if silence is detected. The following type of path can be used to tell VoiceGuide which module to go to next if a silence is detected;

On {silence} Goto [module title]

Minimum silence length and volume parameters can be set by editing the VG.INI configuration file, in section [PlayRecordConfig]. From VG.INI file:

;SilenceDetectLength: 40=4 seconds

The silence detection settings can be set from within the script as well, by assigning values to Result Variables SilenceDetectLvl and SilenceDetectLen using the Evaluate Expression module. eg. To disable silence detection from within the script use:


Result Variables

$RV[ModuleTitle] will store the filename of the recorded sound file. Includes the full directory path.

$RV[ModuleTitle_EndRecCause] will store the reason why recording was stopped.

$RV[ModuleTitle_RecLen100ms] will store the recording length in 100ms units (eg. a value of 75 equals seven and a half seconds).


Call Recording - Recording Conversations

The Record_2Lines_Start function can be used to record both sides of the conversation.
Record_2Lines_Start supports recording of both sides of a brdged conference call.
Record_2Lines_Start also supports recording of both sides of the Caller<->IVR connection - recording what IVR plays to the caller and the callers responses.