VOCP System - BoxConf - BoxTypes
This document presents the various box types used by VOCP.
To create, edit and manage you voice mail system configuration, you use the BoxConf configuration GUI as the root user. When creating a new box, you will be asked to select the type of box from a list. The available box types, and the conditions surrounding their use, are described here.
One feature is common to all boxes - they have a number (normally, three digits). This number must be unique as a caller can access any box directly by entering the box number after any prompt (by using *NNN#, where NNN is the box number).
Most boxes may have a message set. This message is the name of the rmd file to play upon entering the box. This filename is should be entered relative to /var/spool/voice/messages, thus if you have these two files on you hard drive
you would enter messages rootbox.rmd and spanish/welcome.rmd, respectively.
A number of box configuration parameters are common to a few types of boxes. Boxes will safely ignore parameters that are irrelevant to them (for instance, a faxondemand box will ignore the owner attribute).
The none box is key to user navigation. Its name is derived from the fact that no action is taken upon entering this box, except perhaps playing a message. none boxes are used to implement menues and messages for callers.
none boxes must at a minimum, either have a message or autojump set (they may have both).
When the box is entered, the message will be played if it is set.
If branches are specified (eg 1=100,2=200,0=998) single digit user input will move the caller to the appropriate box (box 100, for input 1 in this example).
If autojump is set, the caller will jump to the box number specified after the message plays.
Accessing these boxes may terminate the VOCP session, if the box is a dead end (no autojump, no branches).
The command boxes may be accessed by logging into the system (they are described in greater detail in the command shell section of the site or the included doc/command-shells.txt file). They provide a command shell on the VOCP system, from which the logged on caller can execute selected programs and hear resulting output (be it numeric, a sequence of sound files to play or text-to-speech output). Command shells are a powerfull feature but, as such, require some extra attention when configuring - so be sure to check out command-shells.txt.
These boxes must have a valid system user set as the owner and a password set.
The exit boxes do just that - they exit the system. They may have a message set, in which case the message will be played upon entering the box. After message play, the system exits and the call is terminated.
We use the exit box to provide a 1 key hangup by creating an exit box with number 998 and adding 0=998 to the branches of the root (001) box. That way, when VOCP answers at the same time as you do, you may press 0, the system hangs up and you can continue with the call.
Accessing these boxes will (obviously) terminate the VOCP session.
The faxondemand boxes allow you to give callers access to a number of faxes of their choice. Upon entering the box, the message is played if it is set then the modem switches to fax mode and sends the file set with the fax to send field.
This fax to send must be set the full path to a file in an appropriate format (g3). You can convert postscript or a variety of image formats to g3 using the VOCPhax interface.
Accessing these boxes will terminate the VOCP session, causing mgetty to go into fax mode and handle the remainder of the call to send the fax.
The group boxes act like mailing lists for voicemail. group boxes have members (a list of comma separated box numbers, eg 100,200,500). The members must be mail type boxes or other group boxes. When a group box is accessed, the message is played (if set), the caller is beeped and recording commences. After the recording is done, the message is delivered to all mail boxes in the group and all mail boxes in the groups contained within the group, recursively.
These boxes must have at least 1 member.
Accessing these boxes will terminate the VOCP session after the message has been recorded.
The mail boxes are end points in the call flow where callers may leave voicemail messages. These boxes must have an owner and a password set. Upon accessing the box, callers will hear the message (if set) and then record a message that will be delivered to the box.
Accessing these boxes will terminate the VOCP session. The box owners can call the system and log into their mail boxes, to retrieve and delete their voicemail messages.
The pager boxes ask callers to enter a numeric message (composed of DTMF digits) and delivers an 'email page' with the contents of the caller input to the box's email address. These boxes must have an email address set.
Accessing these boxes will terminate the VOCP session after the caller has entered the number and pressed #.
The receivefax boxes allow you to create a box that, when accessed, plays the message (if set), terminates the VOCP session and switches the modem to fax mode. Callers may use this box to send faxes to you. This box is not, strictly, necessary (as VOCP will intercept the fax tone of an incoming fax call and exit appropriately) but may be useful.
Accessing these boxes will terminate the VOCP session and let mgetty handle the rest of the call, in fax mode.
The script box is akin to a command shell box in that it will (optionally) accept user input (whether numeric or textual), run a local program and use that program's output to answer the user. Depending on the type of return specified in the configuration, VOCP will either
These boxes must have an owner set and the script they run must be either owned by the box owner or the root user. Scripts currently run as the owner of the box, so be careful with who has control of the scripts and the box configuration. A good technique, if you have no need to run a script as a particular user, is to have the scripts owned by root, mode 0755 and have the script boxes owned by a user like nobody or some other specially created and powerless user.
If the box is a dead end (no autojump, etc. set) or has a return of sendfax, the call will terminate after access to the box.
We have covered all the currently support VOCP box types. The boxconf program should be rather intuitive but check the box configuration section of the site and let us know if you are having difficulties.