334
The Dial Plan Configuration File
The dial plan configuration file defines rules for gathering digits when dialing a phone number and also defines the
mapping of the gathered digits to a specific target. A sample dial plan is defined below.
<C1DIALPLAN>
<SYSCONFIG DIALTIME=”120000” FIRST_DIGIT_WAIT=”30000” INTER_DIGIT_WAIT=”30000”
TERMINATION_DIGIT=”#”/>
<DIGITMAP MATCH=”911” MIN_DIGITS=”3” MAX_DIGITS=”3” STRIP_FIRST_DIGITS=”0” ADD_PREFIX_
AFTER_STRIP=”” DIAL_STRING=”+&@sipgateway.com”/> <!-- 911 Emergency -->
<DIGITMAP MATCH=”+&” MIN_DIGITS=”4” MAX_DIGITS=”4” STRIP_FIRST_DIGITS=”0” ADD_PREFIX_
AFTER_STRIP=”” DIAL_STRING=”+&@sipproxy.com”/> <!-- Enterprise extenions -->
<DIGITMAP MATCH=”9” MIN_DIGITS=”8” MAX_DIGITS=”43” STRIP_FIRST_DIGITS=”1” ADD_PREFIX_
AFTER_STRIP=”” DIAL_STRING=”+&@sipgateway.com”/> <!-- Outside dialing -->
<DIGITMAP MATCH=”0” MIN_DIGITS=”1” MAX_DIGITS=”1” STRIP_FIRST_DIGITS=”0” ADD_PREFIX_
AFTER_STRIP=”” DIAL_STRING=”operator@sipproxy.com”/> <!-- Operator -->
</C1DIALPLAN>
NOTE: All tokens associated with the SYSCONFIG and DIGITMAP MUST appear on separate
single lines in the actual configuration file.
NOTE: Although the dial plan configuration file may appear to be well formed XML, it MUST
adhere to the format defined above.
The DIALTIME token defines the total time in milliseconds allowed to enter the dialed digits before the phone will
play a re-order tone.
The FIRST_DIGIT_WAIT token defines the time in milliseconds the phone will wait after going off-hook to enter
the first digit before the a re-order tone is played.
The INTER_DIGIT_WAIT token defines the time in milliseconds the phone will wait after the first digit is entered
before another digit must be entered before the number is dialed.
The TERMINATION_DIGIT token defines the termination digit to be entered if the maximum number of digits
have not yet been entered and the number is to be dialed before the INTER_DIGIT_WAIT timer is still active.
The MATCH token defines the digits which MUST be matched when the user begins entering digits for the
DIGITMAP rule to take effect.
The MIN_DIGITS token defines the minimum number of digits which MUST be entered once that match rule has
been invoked. This number must be greater than or equal to the number of digits in the MATCH string.
The MAX_DIGITS token defines the maximum number of digits which MAY be entered after the match rule has
been invoked. The completion of the number may be achieved when the maximum number of digits have been
entered or the TERMINATION_DIGIT is pressed. The MAX_DIGITS parameter MUST be greater than or equal to
the MIN_DIGITS parameter.
The STRIP_FIRST_DIGITS parameter defines the number of digits that will be stripped from the beginning of the
complete dial string before it is passed to the underlying stack to be dialed. For example if the user entered 1234
and STRIP_FIRST_DIGITS was set to 2, the string passed to the underlying stack for dialing would be 34.
The ADD_PREFIX_AFTER_STRIP token defines a set of prefix characters that are to be applied to the beginning
of the dial string AFTER the STRIP_FIRST_DIGITS rule has been applied. Adding to the previous example, if the
ADD_PREFIX_AFTER_STRIP were set to “56” and the user entered 1234, the string passed to the underlying
stack would be 5634.
The DIAL_STRING token defines the address which will be dialed when a number satisfying the MATCH rule is
entered.
The characters “+&” define a wild card, which can be entered to simplify entering multiple rules for similar
addresses. In the example shown above, when any four digit number is entered, it is passed to the stack as
“<four digit number>@sipgateway.com”.
NOTE: Although the wild card parameter is defined in the MATCH string and in the DIAL_
STRING, it assumes that the rules applied for STRIP_FIRST_DIGITS and ADD_PREFIX_
AFTER_STRIP still take effect before the entered number replaces the wild card in the
DIAL_STRING.
