Tcl commands for vboxgetty
With vbox version 2.0, tcl can be used as a script language to act on incoming calls.
Incoming calls are still taken by vboxgetty, but further actions are made by the tcl script.
These are additional variables supplied by vboxgetty.
directory with vbox commands.
name for this message to save. The name is constructed from time and process id. It's a good idea to use this name, but you can also use a different name.
maximum seconds to record.
path of the users spool directory (/var/spool/vbox/<user>).
path for new files (/var/spool/vbox/<user>/incoming).
filename with full path of the message to play as the standard message (/var/spool/vbox/<user>/messages/standard.msg).
filename with full path of the message to play as beep (/var/spool/vbox/<user>/messages/beep.msg).
filename with full path of the message to play after a timeout (/var/spool/vbox/<user>/messages/timeout.msg).
CALLERID of current caller. If unknown, this is "0".
full phone number of current caller. If unknown, this is "*** Unknown ***".
name of current caller. If unknown, this is "*** Unknown ***".
name of the user that runs this vboxgetty.
home directory of the user that runs this vboxgetty.
this is TRUE if the script should play the standard message, and FALSE if the script should not.
this is TRUE if the script should play the beep message, and FALSE if the script should not.
this is TRUE if the script should play the timeout message, and FALSE if the script should not.
this is TRUE if the script should record a message, and FALSE if the script should not.
vboxgetty also provides some additional functions to the user.
Most functions will use these return codes:
An error occurred.
The connection was ended. Script should end now.
The whole message was played, nothing occurred.
Any other error code is a touchtone sequence, that was detected during playing the message.
vbox_breaklist <add|rem> <sequence> [...]
With this command you can control which touchtone sequences vboxgetty will recognize.
Touchtone sequences have the format *NUMBER#, where NUMBER is a sequence of the characters 0-9 and A-D. Even single numbers must be given in the format *NUMBER#. Vboxgetty detects if the caller gives a number as a single digit or as a part of a sequence.
add <sequence> [...]
Add a touchtone sequence to breaklist. You can add up to 8 sequences at one time.
rem <sequence> [...]
Remove a touchtone sequence from breaklist. You can remove up to 8 sequences at one time. You can use all to remove all sequences.
Play a message and returns an error code depending on the reason to stop playing. Default return codes.
full name of the message file (with path).
vbox_get_message <savename> <timelimit>
Records a message. Default return codes. Options are:
full name of the file for saving the message.
maximum time to record the message.
Waits for several seconds for an input from caller. Default return codes. Options are:
time to wait.
Clears vboxgetty touchtone sequence. Normal way is to append all new touchtones to the sequence, the sequence is only cleared when a "*" touchtone is received.
waits a specific number of milliseconds.
number of milliseconds to wait.
Return the number of new messages in the directory.
the directory to scan
Return the number of messages in the directory.
the directory to scan
This manual page was written by Andreas Jellinghaus <[email protected]>, for Debian GNU/Linux and isdn4linux.