Configuring inband properties

PBX integration establishes communication between the PBX and the voice mail system. The PBX supplies information such as who is calling on internal calls and the extension that the caller is trying to reach.

With inband integration, the MAS receives information about an incoming call from the PBX in a call information packet. The call information packet contains DTMF digits indicating the type of call (known as the call packet type), the called party ID, the calling party ID, and the trunk ID.

To display the PBX Integration dialog box, Inband tab:

In the Voice Mail System Configuration window, click Message Application Servers.

Click the MAS you want to configure.

You may need to expand the tree to see the all the MASs in the voice mail domain.

Double-click PBX Integration for that MAS.

The system displays the PBX Integration dialog box, with the General tab active.

Click the Inband tab.

To configure PBX integration inband properties, configure the following fields:

Maximum Inter-digit Gap (ms) Enter the time, in milliseconds, for the delay between each DTMF digit in the call information packet. This setting does not apply to the delay until the first DTMF digit arrives in a call information packet. The range is 16 through 999, and the default is 48.

Pause before Inband Digits (ms) Enter the maximum time, in milliseconds, to wait after taking the voice port off hook before the first DTMF digit arrives in a call information packet. The range is 100 through 9999, and the default is 2500.

DTMF On Time (ms) Enter the length (duration), in milliseconds, of a DTMF digit in a call information packet. The range is 32 through 999, and the default is 32.

Search Entire String for Reason Code Select to allow the integration service to search the entire call information packet for the call packet type (also known as the reason code). The call packet type is a string of DTMF digits that form a code for the type of call received, such as a direct call, a forwarded call, or a diverted call. If this field is cleared, the integration service looks for the call packet type at the digit position specified in the Location of Inband Reason Code field. This check box is cleared by default.

Tip: If you do not know the location of the inband reason code (call packet type), you can get this information by making a call of the appropriate call packet type and checking the call information in using Operation History Viewer. To do this, you must first set the Maximum Inter-digit Gap and the Pause before Inband Digits to high values, and select the Log Inband Packets check box.

Location of Inband Reason Code Enter the position within the call information packet of the first DTMF digit in the call packet type (also known as the reason code). The call packet type is a string of DTMF digits that form a code for the type of call received, such as a direct call, a forwarded call, or a diverted call. Each call information packet must have a call packet type.

For example, if the call packet type is the first field in the call information packet, enter 1. If the call packet type is the second field in the call information packet and follows a field that is 6 DTMF digits in length, enter 7. In this case, the first DTMF digit in the call packet type is the 7th DTMF digit in the call information packet.

The range is 1 through 99, and the default is 1.This field is not available if Search Entire String for Reason Code is selected.

Log Inband Packets Select to log the inband call information packets in the operation history database. When selected, inband call information can be viewed in Operation History Viewer. This check box is cleared by default.

Fixed Length Packets Select if your PBX sends out call information packets of a fixed length. Within fixed length call information packets, each piece of call information, that is, the call packet type, the calling party ID, the called party ID, and the trunk ID, is in a fixed position.

In the following example, the call packet type starts at position 1 (the first DTMF digit in the packet), the called party ID starts at position 4 (the 4th DTMF digit in the packet), the calling party ID field starts at position 11 (the 11th DTMF digit in the packet), and the trunk ID field starts at position 18 (the 18th DTMF digit in the packet). The total fixed packet length is 21.

Call packet type	Called party ID field	Calling party ID field	Trunk ID field
XXX	XXXXXXX	XXXXXXX	XXXX
Start position = 1	Start position = 4	Start position = 11	Start position = 18

You define the length and position of fields in call information packets using settings in the Inband Protocol Settings dialog box (see Configuring inband properties).

If this check box is cleared, the packet length is variable. This check box is cleared by default.

Filler Character Select the filler character used in the call information packet. A filler character is required if your PBX sends out fixed length call information packets. The filler character is the character that is used to fill in blanks in a fixed length field, if the number of DTMF digits received is less than the fixed number defined.

For example, if the fixed length of a called party ID field is 7 (as defined in the Inband Protocol Settings dialog box), but only 4 DTMF digits are received, 3 filler characters are required to maintain the fixed length of the call information packet. These are added after the DTMF digits in the called party id field.

You can select from *, #, A, B, C, D, 0, or <NONE>. 0 is available only if the Right Alignment of Digits in a Field check box is selected. Note that the filler character cannot be the same as the delimiter character.

In the following example, hash (#) is used as the filler character.


Call packet type 3 digits	Called party ID 7 digits	Calling party ID 7 digits	Trunk ID 4 digits
11#	4001###	6783000	3008

The default is asterisk (*).

Delimiter Character Select the delimiter character used in call information packets to distinguish between different fields. For example, in the following call information packet, * is used to distinguish between the call packet type, called party ID, calling party ID, and trunk ID:

1000*4001234*6009*1200

You can select from *, #, A, B, C, D, or <NONE>. <NONE> is available only if the Fixed Length Packets check box is selected. The default is #. Note that the delimiter character cannot be the same as the filler character.

Right Alignment of Digits in a Field Select to indicate that in a fixed length call information packet, the DTMF digits in each field are to be right aligned. This check box is cleared by default.

Request String Supported Select if your PBX requires the MAS to send it a request string before it can send the call information packet. If selected, two fields are enabled, Inband Request Digit String and Pause before Request String.

Inband Request Digit String Enter the sequence of DTMF digits that the MAS must send to the PBX when requesting a call information packet. The range is 0 through 99, and the default is blank. This field is available only if the Request String Supported check box is selected.

Pause before Request String (ms) Enter the time, in milliseconds, before the MAS sends the request string to the PBX after going off hook. The PBX may require this time to stabilize. The range is 0 through 10000, and the default is 500.

Click Protocol Settings...

The system displays the Inband Protocol Settings dialog box, where you can configure inband protocol types. For more information, see Configuring inband protocol types.

To close the Inband Protocol Settings dialog box and return to the Inband tab, click OK.

Click MWI Settings.

The system displays the MWI Settings dialog box, where you can configure message waiting indicator (MWI) settings. For more information, see Configuring MWI settings.

To close the MWI Settings dialog box, click OK.

After making these settings, you must stop and restart the MAS service for the settings to take effect.