Record Module

Records to a sound file.

Recording will finish when any of the following occurs:

  • silence is detected
  • the caller hangs up
  • a key that has a path defined for it is pressed
  • a set timeout is reached

Following can be specified in the ‘Sound File to Record’ text box:

  • Full filename of the destination file
    Recording will be made into the specified file. If a file with this name exists already then it will be overwritten.
  • Just the directory into 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 “\
  • Leave the 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 file name generated will follow this template:


    MM : 2 digit month
    DD : 2 digit day
    HH : 2 digit hour
    NN : 2 digit minute
    SS : 2 digit second
    LineId : LineId of line handling the call
    CallerID : Caller's telephone number


Maximum Record Length

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

The paths screen below has a Timeout path which would result in the recording in that maodule to continue for up to 30 seconds, after which the caller would be sent to the Main Welcome module.
If the caller presses any of the keys that have paths defined for it, the recording will terminate and the caller will be sent to the module specified in the path (in this case all paths lead back to the Main Welcome module.


Silence Detection

The recording will 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 bridged 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 caller's responses.