Dialogic M7324 User Manual

Dialogic^®PBX Integration

Board User’s Guide

05-1277-010

Table of Contents

1. How to Use This Manual .............................................................................. 11

1.1. Audience ...................................................................................................... 11

1.2. Product Terminology ................................................................................... 11

1.3. PBX Models Covered in This Manua l ......................................................... 12

1.4. Documentation Conventions........................................................................ 13

1.5. Dialogic^®Voice Hardware Covered by This Manual .................................. 14

1.5.1. Dialogic^®Voice Hardware Model Names........................................... 14

1.6. When to Use This Manual ........................................................................... 15

1.7. How This Manual Is Organize d ................................................................... 15

2. Introduction to PBXs and KTS s .................................................................. 17

2.1. Supervised Call Transfer.............................................................................. 19

2.2. Blind Call Transfer....................................................................................... 20

2.3. Caller ID....................................................................................................... 21

2.4. Called Number I D ........................................................................................ 22

2.5. Positive Disconnect Supervision.................................................................. 23

2.6. In-Band Signaling ........................................................................................ 24

2.7. Out-of-Band Signalin g ................................................................................. 24

2.8. Read Display Messages................................................................................ 24

2.9. “Pressing” Keys ........................................................................................... 25

2.10. Message Waiting Indication....................................................................... 25

2.11. Automated Attendant ................................................................................. 25

3. PBX Integration Overvie w ........................................................................... 27

3.1. Voice Features Supported ............................................................................ 27

3.2. PBX Integration Features Supported ........................................................... 29

3.2.1. Dialogic^®Unified API......................................................................... 29

3.3. Dialogic^®PBX Integration Board Description ............................................ 31

3.3.1. Features ............................................................................................... 31

3.3.2. Functional Description ........................................................................ 32

3.3.3. Configuration s ..................................................................................... 34

3.3.4. Software Support................................................................................. 34

4. PBX Systems.................................................................................................. 37

4.1. Avaya Definity PBXs................................................................................... 37

4.1.1. Avaya Switch Programming Requirements ........................................ 37

4.1.2. Using the Dialogic^®PBX Integration Board....................................... 39

4.1.3. Programmable Feature Keys ............................................................... 41

Dialogic^®PBX Integration Board User’s Guide

4.1.4. Avaya Function Key s .......................................................................... 45

4.1.5. Display Keys ....................................................................................... 46

4.1.6. Alphanumeric Display......................................................................... 46

4.1.7. Setting the Message Waiting Indicator................................................ 49

4.1.8. Transferring a Call............................................................................... 50

4.2. Siemens ROLM PB X ................................................................................... 52

4.2.1. Siemens ROLM Programming Requirement s ...................................... 52

4.2.2. Using the Dialogic^®PBX Integration Board....................................... 54

4.2.3. Programmable Feature Keys ............................................................... 55

4.2.4. Alphanumeric Display......................................................................... 59

4.2.5. Setting the Message Waiting Indicator................................................ 62

4.2.6. Transferring a Call............................................................................... 63

4.3. Siemens Hicom PBX.................................................................................... 65

4.3.1. Siemens Hicom Programming Requirements....................................... 65

4.3.2. Using the Dialogic^®PBX Integration Board....................................... 67

4.3.3. Programmable Feature Keys ............................................................... 69

4.3.4. Alphanumeric Display......................................................................... 72

4.3.5. Setting the Message Waiting Indicator................................................ 75

4.3.6. Transferring a Call............................................................................... 79

4.4. Mitel Superswitch PBX s .............................................................................. 81

4.4.1. Mitel Superswitch Programming Requirements.................................. 81

4.4.2. Using the Dialogic^®PBX Integration Board....................................... 86

4.4.3. Programmable Personal Keys for Mitel Superset Emulatio n .............. 88

4.4.4. Function Keys ..................................................................................... 92

4.4.5. Display (Soft) Key s ............................................................................. 93

4.4.6. Alphanumeric Display......................................................................... 96

4.4.7. Setting the Message Waiting Indicator.............................................. 101

4.4.8. Transferring a Call............................................................................. 102

4.5. Nortel Norstar and Nortel BCM................................................................. 104

4.5.1. Nortel Norstar Programming Requirements...................................... 105

4.5.2. Nortel BCM Programming Requirement s ......................................... 115

4.5.3. Using the Dialogic^®PBX Integration Board..................................... 120

4.5.4. Programmable Memory Keys............................................................ 121

4.5.5. Display Keys ..................................................................................... 124

4.5.6. Alphanumeric Display....................................................................... 126

4.5.7. Setting the Message Waiting Indicator.............................................. 129

4.5.8. Transferring a Call............................................................................. 131

4.5.9. Called ID on Forwarded Calls........................................................... 134

4.6. Nortel Meridian 1....................................................................................... 139

4.6.1. Nortel Meridian 1 Programming Requirements ................................ 139

Table of Contents

4.6.2. Using the Dialogic^®PBX Integration Board..................................... 140

4.6.3. Programmable Feature Keys ............................................................. 142

4.6.4. Alphanumeric Display....................................................................... 144

4.6.5. Setting the Message Waiting Indicator.............................................. 147

4.6.6. Transferring a Call............................................................................. 148

4.7. NEC NEAX 2000/2400 PBXs and Electra Elite KT S ............................... 150

4.7.1. NEC Programming Requirement s ..................................................... 150

4.7.2. Using the Dialogic^®PBX Integration Board..................................... 151

4.7.3. Flexible Line Keys ............................................................................ 153

4.7.4. Function Keys ................................................................................... 157

4.7.5. MIC and ICM LED Indicators .......................................................... 158

4.7.6. Alphanumeric Display....................................................................... 159

4.7.7. Setting the Message Waiting Indicator.............................................. 162

4.7.8. Transferring a Call............................................................................. 164

4.7.9. Primary Appearance Location Note .................................................. 165

Appendix A - Technical Specifications........................................................... 167

Glossary ............................................................................................................ 171

Index.................................................................................................................. 175

Dialogic^®PBX Integration Board User’s Guide

List of Tables

Table 1. Avaya Definity Configuration Example ............................................... 38

Table 2. Avaya 7434 and 8434 LED Indicator States......................................... 42

Table 3. Avaya 7434 and 8434 Direct Key Dialing Strings for Feature Keys... 42

Table 4. Avaya 7434 and 8434 Direct Key Dialing Strings for Function Keys.. 45

Table 5. 8434 Direct Key Dialing Strings for Display Keys............................... 46

Table 6. Called/Calling Number ID Data for the Avaya Definity ...................... 48

Table 7. ROLMphone 400 LED Indicator States................................................ 56

Table 8. ROLMphone 400 Direct Key Dialing Strings for Feature Keys........... 57

Table 9. Called/Calling Number ID Data for the ROLM.................................... 61

Table 10. Optiset E LED Indicator State s ........................................................... 70

Table 11. Optiset E Direct Key Dialing Strings for Feature Keys with Hicom

15 0 ............................................................................................................... 70

Table 12. Optiset E Direct Key Dialing Strings for Feature Keys with Hicom

30 0 ............................................................................................................... 71

Table 13. Called/Calling Number ID Data for the Hicom .................................. 74

Table 14. Phone and PBX Interoperability ......................................................... 81

Table 15. Mitel Superset 420/430 LCD Line Indicator State s ............................ 89

Table 16. Mitel Superset 420 LCD Line Indicators (with SX-50) and Dial

Strings.......................................................................................................... 89

Table 17. Mitel Superset 430 LCD Line Indicators (with SX-200 and SX-

2000) and Dial Strings................................................................................. 90

Table 18. Mitel Superset 420 Direct Key Dialing Strings for Function Keys .... 92

Table 19. Mitel Superset 430 Direct Key Dialing Strings for Function Keys .... 93

Table 20. Mitel Superset 420 Direct Key Dialing Strings for Display Keys ...... 96

Table 21. Mitel Superset 430 Direct Key Dialing Strings for Display Keys ...... 96

Table 22. Called/Calling Number ID Data for the Mitel Superset...................... 99

Table 23. Norstar Configuration Requirements (DR5 )..................................... 105

Table 24. BCM Configuration Requirements ................................................... 116

Table 25. M7324 LCD Indicator States ............................................................ 122

Table 26. M7324 Direct Key Dialing Strings for Memory Keys...................... 122

Table 27. M7324 Direct Key Dialing Strings for Display Key s ....................... 126

Table 28. Called/Calling Number ID Data for the Nortel Norsta r .................... 128

Table 29. Called/Calling Number ID Data for the Nortel BC M ....................... 128

Table 30. Nortel Meridian 1 Configuration Requirements ............................... 140

Table 31. M2616 LCD Indicator States ............................................................ 142

Table 32. M2616 Direct Key Dialing Strings for Feature Keys ....................... 143

Table 33. Called/Calling Number ID Data for the Meridian 1 ......................... 146

List of Figures

Figure 1. Dialogic^®PBX Integration Board Functional Block Diagram ............ 33

Figure 2. Avaya 7434 Telephon e ........................................................................ 40

Figure 3. Avaya 8434 Telephon e ........................................................................ 41

Figure 4. Siemens ROLMphone 400 .................................................................. 55

Figure 5. Siemens Optiset E Telephone with the Hicom 150 ............................. 68

Figure 6. Siemens Optiset E Telephone with the Hicom 300 ............................. 69

Figure 7. Optiset E Message Waiting Display with Hicom 150 ......................... 78

Figure 8. Mitel Superset 420 Telephon e ............................................................. 87

Figure 9. Mitel Superset 430 Telephon e ............................................................. 88

Figure 10. Mitel Superset 420/430 LCD Line Indicator ..................................... 91

Figure 11. Mitel Superset 420 Display Keys ...................................................... 94

Figure 12. Nortel M7324 Telephone................................................................. 121

Figure 13. M7324 Display Key s ....................................................................... 125

Figure 14. M7324 Message Waiting Display ................................................... 131

Figure 15. Nortel M2616 Telephone................................................................. 141

Figure 16. NEC DTerm Series III Telephone ................................................... 152

Dialogic^®PBX Integration Board User’s Guide

1. How to Use This Manual

1.1. Audience

This manual is intended for programmers and engineers who choose to use

Dialogic^®PBX Integration Boards and Dialogic^®APIs to develop a computer

telephony application for use on a PBX.

When this manual addresses “you,” it means “you, the programmer,” and when

this manual refers to the “user,” it means an end-user of an application program.

1.2. Product Terminology

This manual includes information relevant to those choosing to use a Private

Branch Exchange (PBX) or Key Telephone System (KTS) with a Dialogic^®PBX

Integration Board. A PBX is a privately owned, mini version of a telephone

company’s central office (CO) switch. Grouped with PBXs are KTSs, which are

generally smaller versions of a PBX that provide direct access to CO telephone

lines. For simplicity, the term PBX is sometimes used herein to denote a PBX, a

KTS, or both.

In a PBX environment a line from the CO is called a trunk and a phone is called a

line, extension, or station.

Dialogic^®PBX Integration Board User’s Guide

1.3. PBX Models Covered in This Manual

This manual currently includes support for the following PBXs and KTSs and

associated telephones:

Manufacturer PBX Hardware

Telephone Emulations

Avaya

Definity System 75

7434 (4-wire)

8434 (2-wire)

Definity System G3 Ver. 4

and higher

Mitel

SX-50

Superset 420 (DNIC)

Superset 430 (DNIC)

SX-200

SX-2000

NEC

NEAX 2000 IVS, IVS2, IPS

NEAX 2400 IMS

DTerm Series III

Electra Elite, Electra

Professional 120

Nortel

Norstar DR5, CICS, and

MICS

M7324

M2616

Business Communications

Manager (BCM)

Meridian 1

Siemens

ROLM CBX 9005, 9006 and ROLMphone 400 (RP400)

9715

Hicom 150, North America

and 300, North America

Optiset E

1. How to Use This Manual

1.4. Documentation Conventions

The following documentation conventions are used throughout this manual:

•

When terms are first introduced, they are shown in italic text.

Data structure field names and function parameter names are shown in

boldface, as in maxsec.

•

Function names are shown in boldface with parentheses, such as

d42_display( ).

•

Names of defines or equates are shown in uppercase, such as T_DTMF.

File names are italicized and in uppercase, such as D42DRV.EXE.

Examples included in this manual show data that is stored in an application

buffer. The contents of a buffer are illustrated as follows:

Application buffers are typically 48 bytes long (plus a null). The actual data

(in HEX) is shown in the gray area. The bytes referenced in the example are

shown in boldface.

Dialogic^®PBX Integration Board User’s Guide

1.5. Dialogic^®Voice Hardware Covered by This Manual

The Dialogic^®PBX Integration Board voice hardware provides a set of cost-

effective tools that enable implementation of computerized voice and call

processing applications for PBXs. It provides the basic voice and call processing

capabilities of Dialogic^®D/4x voice hardware, and adds hardware and firmware

that can ease integration with supported PBXs. Refer to the Dialogic^®Voice API

Programming Guide for more information on voice and call processing.

The Dialogic^®PBX integration hardware models covered by this manual include

the following Dialogic^®boards:

•

Dialogic^®D/42JCT-U Board – a 4-channel voice board with station

interfaces that can be connected directly to a number of different PBXs.

Dialogic^®D/82JCT-U Board – an 8-channel voice board with station

interfaces that can be connected directly to a number of different PBXs.

1.5.1. Dialogic^®Voice Hardware Model Names

Model names for Dialogic^®Voice boards are based on the following pattern:

D/NNNoRBB-TT-VVV

where:

•

D/ - identifies the board as Dialogic^®voice hardware

NNN - identifies the number of channels (2, 4, 8, 12, etc.), or relative

size/power measure

•

o - 0 indicates no support for call progress analysis; 1 indicates support for

call progress analysis; and 2 indicates PBX support

R - if present, this represents board revision (D, E, J, etc.)

BB - bus type (SC or CT)

TT - telephony interface type (if applicable; valid entries include LS, T1, E1,

BR, U (for universal PBX Interface))

•

VVV - ohm value (if applicable; valid entries are 75 and 120)

Sometimes this document refers to a group of Dialogic^®voice boards rather than

specific models, in which case an “x” is used to replace the part of the model

1. How to Use This Manual

name that is generic. For example, D/xxx refers to all models of the Dialogic^®

voice hardware, and D/8x refers to all 8-channel models of the Dialogic^®voice

hardware.

1.6. When to Use This Manual

This Dialogic^®PBX Integration Board User’s Guide contains information for

those choosing to configure and use specific PBX hardware with Dialogic^®PBX

Integration Boards. For information about installing hardware, refer to the

Dialogic^®PBX Integration Quick Install Card provided with your board. For

information about installing PBX integration software, refer to the Dialogic^®

System Release Software Installation Guide for your Dialogic^®System Release

Software.

1.7. How This Manual Is Organized

Chapter 1 – How to Use This Manual describes the Dialogic^®PBX Integration

Board User’s Guide.

Chapter 2 – Introduction to PBXs and KTSs provides a brief description of

Private Branch Exchanges (PBXs), Key Telephone Systems (KTSs), and hybrid

systems.

Chapter 3 – PBX Integration Overview provides information about the voice

and PBX-specific features supported by the Dialogic^®PBX integration products,

as well as a description of the Dialogic^®Unified API.

Chapter 4 – PBX Systems contains general descriptions, capabilities, switch

requirements, and direct key dial sequences of the supported PBXs.

Appendix A – Technical Specifications contains technical specifications for the

Dialogic^®PBX Integration Boards.

Glossary contains a list of definitions for commonly used terms.

Index contains an alphabetical index of features and topics.

Dialogic^®PBX Integration Board User’s Guide

2. Introduction to PBXs and KTSs

A PBX, or private branch exchange, is a telephone system that is usually

installed in a business. It provides service among many extensions within the

business as well as outside lines. Typically, PBXs are used when a large number

of extensions are needed. A PBX can be thought of as a mini version of a

telephone company's central office (CO) switch. Advantages offered by a PBX

include:

•

increased efficiency and cost savings because a specific number of CO

telephone lines are shared among a large group of users

special PBX features

Grouped with PBXs are key telephone systems (KTSs). A KTS is generally a

smaller version of a PBX that also provides direct access to outside telephone

lines (trunks). When you press a "line" key on a KTS you immediately hear a dial

tone from the central office. In contrast, on a PBX system, you have to dial a

digit, usually "9", to get the dial tone from the central office. Typically, KTSs are

used when fewer than 50 extensions are needed. Advantages offered by KTSs

include that anyone in a supported office can answer an incoming call simply by

pressing the correct line button, and that KTSs usually cost less than PBXs.

Systems have been developed that combine PBX and KTS features. These hybrid

systems typically serve up to 100 users and contain some features found only in

PBXs (the ability to use single line phones) and features typically found in KTSs

(hands free announcing and answerback). An example of a hybrid system is the

NEC Electra Professional, which can connect to a maximum of 64 outside lines

and 96 extensions. Some features include least cost routing, call forwarding, call

hold, automated attendant, and caller ID.

As noted above and for simplicity, throughout this manual the term PBX is

sometimes used to denote a PBX, a KTS, or a hybrid system that combines both.

Many PBX systems are digital. In a digital system, both the voice signals and

control information transmitted between station sets within the PBX are sent as

binary data. Analog voice signals received from outside the PBX (usually a CO)

are converted to digital voice data and sent through the PBX. Digital voice data

Dialogic^®PBX Integration Board User’s Guide

may be sent outside the PBX if outside networks also use digital circuits;

however, they are usually converted back to analog voice signals.

PBXs use control information to instruct their station sets to perform specific

functions such as setting the message waiting indicator and call transfer. This

control information is sent using proprietary digital protocols. A protocol is a set

of rules relating to the format and timing of data transmissions. These protocols

not only contain control information, but also “message” data that can be used to

significantly enhance computer telephony (CT) applications that use PBX call

control elements such as called/calling number ID.

The term “computer telephony” refers to the ability to interact with computer

databases or applications from a telephone. Computer telephony technology

supports applications such as:

•

automatic call processing

automatic speech recognition

text-to-speech conversion for information-on-demand

call switching and conferencing

unified messaging

voice mail and voice messaging

fax systems, including fax broadcasting, fax mailboxes, fax-on-demand, and

fax gateways

•

transaction processing such as Audiotex and Pay-Per-Call information

systems

call centers

PBXs can communicate with their station sets using in-band or out-of-band

signaling. In-band signaling is a method used by analog (2500) telephones (e.g.,

calling into a PBX and using DTMF to respond to voice prompts). In-band

signals use the same band of frequencies as the voice signal. This method

provides limited integration because there are no standards and different PBXs

provide varying levels of control.

Out-of-band signaling is used by PBXs to send and receive data from station sets

or a CT computer. This data can include information such as called/calling

number ID. Out-of-band signals do not use the band of frequencies used by the

voice signals. They can be transmitted using the same wires as the telephone set,

2. Introduction to PBXs and KTSs

or separate wires (e.g., RS-232). Because of its versatility, out-of-band signaling

is often the selected method.

CT equipment comprises a PC containing a Dialogic^®PBX Integration Board and

a software application. Dialogic^®PBX Integration Boards and Dialogic^®APIs

enable the creation of applications that are tightly integrated with a PBX and that

can take advantage of call control elements.

Below is a list of PBX features and functions currently supported by Dialogic^®

PBX Integration Boards. Note, however, that KTSs and hybrid systems may

support only some of these features.

•

supervised call transfer

blind call transfer

caller ID

called party ID

positive disconnect supervision

in-band signaling

out-of-band signaling

read display messages

“press” programmable keys

message waiting indication

2.1. Supervised Call Transfer

A supervised transfer is a method of transferring an incoming call to another

extension, making use of call progress results (i.e., answered, busy, and ring no

answer). This type of transfer can be likened to the following manual operations:

1. Answer a call.

2. Place the caller on hold.

3. Press the transfer key (hook flash).

4. Dial the destination number.

5. If the destination party answers, hang up (the transfer is complete).

6. If the destination party does not answer, switch back to the caller and provide

choices to leave voice mail, select another extension, or hang up.

Dialogic^®PBX Integration Board User’s Guide

A supervised transfer can be implemented without a Dialogic^®PBX Integration

Board (e.g., using hook flash), but the availability and ease of implementation can

be inconsistent. Choosing to use a Dialogic^®PBX Integration Board and the

appropriate dial string can enable you to initiate a transfer the same way for all

supported switches. Also, by choosing to incorporate call progress analysis, you

can be positioned to offer consistent, high-performance call transfer features in

applications. For example, if during the transfer the application detects a busy

signal, the call is automatically sent to a mailbox.

In a supervised transfer, an incoming call answered by a channel on a Dialogic^®

PBX Integration Board will only be transferred after the PBX Integration Board

establishes a connection with another station (the call is not released to the PBX).

If the extension is busy or does not answer, the PBX Integration Board reconnects

to the original call.

2.2. Blind Call Transfer

A blind transfer is initiated the same way as a supervised transfer. However, after

dialing the destination number, the extension performing the transfer hangs up

and does not wait to determine the outcome of the call. The call is released to the

PBX. Blind transfers are used in voice mail applications. A blind call transfer can

be likened to the following manual operations:

1. Answer a call.

2. Put the call on hold.

3. Press the transfer key.

4. Dial the destination number.

5. Hang up.

The call is immediately sent to the new extension. It is up to the PBX to

determine what to do if the transferred call is not answered (because of busy or no

answer). Usually, if a transferred call is not answered it is routed back to the

voice mail system, and eventually to the operator (or an automated attendant).

A benefit offered by blind transfer is that the immediate release to the PBX frees

the voice processing resources to handle new calls rather than being used to

perform call progress. A potential drawback can occur when phone traffic is

2. Introduction to PBXs and KTSs

heavy, in which case the application may need to handle a call overflow

condition.

An application can perform blind transfers without special integration tools.

However, if using a Dialogic^®PBX Integration Board and the Dialogic^®Unified

API to access the called number ID from the PBX, the application can

differentiate between:

•

a new call coming in that needs to be processed: “Hello and thank you for

calling Dialogic Corporation.”

a call that was transferred at least once already and is being routed by the

PBX into voice mail: “You’ve reached the desk of Marcia Jones in

Engineering; please leave a message.”

If the call was transferred, the application can use the called number ID to send

the call directly into the appropriate voice mail box, allowing the caller to leave a

message without again having to navigate through a series of menus.

2.3. Caller ID

Caller ID is the identification of the phone number from which a call is placed.

These digits are typically transmitted at the beginning of a call, usually between

the first and second ring.

Although telephone companies provide caller ID service to residential customers,

the scope of such commercially available caller ID is different from the caller ID

feature available with many PBXs. The caller ID from the telephone company is

often referred to as automatic number identification (ANI) and identifies callers

whose numbers are assigned by the telephone company. Caller ID from within

the PBX identifies callers whose telephone extensions are assigned through the

PBX (referred to in this document as “calling number ID”).

Calling number ID from within the PBX system has many business applications.

For example, a voice mail application may use calling number ID to let users

reach individual mailboxes without having to dial extra digits. Other applications

may use calling number ID for screening phone calls, allowing employees to

respond to urgent calls first, as well as for automatic voice message reply, without

making users redial the caller’s extension. Calling number ID can be useful if you

need to know who is calling, and from where they are calling.

Dialogic^®PBX Integration Board User’s Guide

2.4. Called Number ID

Called number ID is also a feature provided within a PBX system and is usually

combined with the calling number ID. Called number ID is the phone number of

the extension being called. If a call originates from outside the PBX, it is the

number of the trunk receiving the call. The called/calling number ID remains the

same when a call is routed through the PBX system.

For example, if a call has been routed through the PBX because the first intended

extension was not answered or was busy, the final destination answering the call

can determine the extension that called, plus the extension that was originally

called.

Called number ID can also be used by an application to automatically direct a call

to an appropriate extension or group of extensions based on the number called

(generally the last four digits).

For example, an application may provide specific information about four different

programs through an interactive voice response (IVR) system. Depending on the

phone number being called, the application can route the caller directly to the

desired program:

Program A: 555-1202 (trunk 01)

Program B: 555-1203 (trunk 02)

Program C: 555-1205 (trunk 03)

Program D: 555-1200 (trunk 04)

Through use of a Dialogic^®PBX Integration Board and the Dialogic^®Unified

API, an application can read the called number ID (the trunk line) and route the

call depending on which extension receives the call. If the call is received on

trunk line 01 it will be routed to the extension for Program A. Without access to

the called number ID information, callers would need to listen to a list of prompts

to obtain the four digit extension code to access Program A.

2. Introduction to PBXs and KTSs

2.5. Positive Disconnect Supervision

PBX phone systems detect when an outside caller has “hung up” the phone. This

capability allows the PBX to also hang up, completing the disconnection. Once

the call is fully terminated, not only is the phone line available for other calls, but

the phone company’s billing charge for that call ends. One common way in which

a phone or PBX manages call termination is positive disconnect supervision.

In a typical external call scenario (where a call is placed through a CO, not

between extensions of the PBX), the CO detects when the caller hangs up and

then sends a disconnect signal (loop current drop) to the PBX. The PBX is

responsible for detecting and handling the disconnect signal from the CO.

After receiving a disconnect signal from the CO, the PBX may:

•

terminate the outside call immediately and send a disconnect message to the

called extension

send a disconnect message to the called extension and wait for the called

extension to hang up before formally terminating the call

In both cases, a disconnect message, not a loop current drop, is sent to the called

extension. Standard analog voice boards do not interpret disconnect messages

because these messages are usually digital. Dialogic^®PBX Integration Boards

can, however, detect disconnect messages and send a disconnect event to an

application where it can be used by standard voice programming mechanisms for

handling call termination.

When a call is placed between extensions of the PBX, a disconnect message, not

a loop current drop, is also used to indicate when a caller hangs up. In this

scenario, the application does not know when the caller has hung up and can

receive another call. Dialogic^®PBX Integration Boards can detect the disconnect

message and send a disconnect event to an application.

Not all PBXs have positive disconnect supervision. Refer to the documentation

for your PBX to determine if your PBX provides this feature.

Dialogic^®PBX Integration Board User’s Guide

2.6. In-Band Signaling

PBXs may use a method called in-band signaling to control their station sets.

In-band signals use the same band of frequencies as the audio signal; this is

usually accomplished with touch-tone signals. This method provides a limited

amount of integration because there are no standards, and different PBXs provide

varying levels of control. Call progress tones that even similar models send can

vary. This means that applications, even on identical PBXs, would have to be

tuned with each installation.

An example of in-band signaling is transferring a call using the flashhook method

There is no data (e.g., caller ID information) passed along when the call is

transferred.

2.7. Out-of-Band Signaling

Many PBXs use a method called out-of-band signaling to control their station

sets. Out-of-band signals do not use the band of frequencies used by the voice

signals. These PBXs transmit control signals and data that can include

information such as called/calling number ID. Because of its versatility, out-of-

band signaling is often the selected method.

2.8. Read Display Messages

Many PBX station sets have an LCD or LED screen that can display messages.

The type of information that is displayed varies with the PBX manufacturer and

the programming capabilities of the switch. Typical information includes:

calling/ called number ID from within the switch, ANI digits from the CO, hook

state, time and length of call, name assigned to the extension, and message

waiting notification. With a Dialogic^®PBX Integration Board, this information

can be passed “unprocessed” to the application. This means that the same data

that is sent to the display is captured by the PBX Integration Board.

By capturing the same display messages that a phone set receives, an application

can “see” and “record” the display information. This display information (in

ASCII format) can be useful in CT applications because it enables an application

to know the state of the extension connected to the PBX Integration Board.

2. Introduction to PBXs and KTSs

Applications used with a PBX that provides ANI digits may process the display

data and use those digits to access related database information.

For applications that choose to use a PBX Integration Board to program the

Nortel Norstar, display data is needed. Because the programming menus and key

functions change at different levels within the PBX software, the only way to

know the current menu options is by having display text available.

2.9. “Pressing” Keys

Station sets typically have Feature Keys that can be programmed to perform

specific functions (e.g., transfer, hold, speaker phone, speed dial, or connect to

trunk lines). Since a Dialogic^®PBX Integration Board can emulate a station set,

applications can “press” these keys. If the station set can be used to program

Feature Keys, an application can also control the assignment of programmable

keys. For instance, if a specific key must be assigned to the transfer function, you

can include a sequence of “pressing” keys at the start of the application such that

the environment is set correctly.

2.10. Message Waiting Indication

Many PBX systems turn on message waiting lights on station set phones when

messages arrive, and clear the light after messages are retrieved. These tasks can

be handled manually, by an attendant, or be automated through a voice mail

application. Via a Dialogic^®PBX Integration Board, an application can also

control the state of message waiting indications on other station sets (if this

feature is available on your PBX).

2.11. Automated Attendant

An auto attendant is a device connected to a PBX that answers incoming calls.

After answering, it may perform functions such as playing a greeting, asking the

caller to press a button, or routing the call to the proper destination.

Dialogic^®PBX Integration Board User’s Guide

3. PBX Integration Overview

The Dialogic^®PBX Integration Board combines the voice and fax features

available in the Dialogic^®D/4x product line with the ability to access enhanced

PBX features on several different PBXs. The voice features include:

•

play and record voice messages

dial and recognize DTMF digits

detect and answer incoming calls

call progress analysis

send and receive faxes

The PBX-specific features include:

•

retrieve Called/Calling number ID

retrieve LCD/LED prompts and indicators

read displays

accessing PBX features using dial strings

disconnect supervision

3.1. Voice Features Supported

The Dialogic^®PBX Integration Board uses a dual-processor architecture

comprising a DSP (Digital Signal Processor) and a general purpose

microprocessor to handle voice processing functions. This dual processor

approach off loads many low-level decision making tasks from the host computer.

When a PBX integration system is initialized, firmware is downloaded from the

host PC to the firmware RAM and DSP memory on the Dialogic^®PBX

Integration Board. This downloadable firmware gives the board its intelligence

and enables feature enhancement and upgrades. Based on this, the PBX

Integration Board can perform the following operations on incoming calls:

•

automatically control the volume of the incoming audio signal

record and compress the incoming audio voice signal. Sampling rates and

coding methods are selectable on a channel by channel basis.

Dialogic^®PBX Integration Board User’s Guide

•

detect the presence of tones - DTMF, MF, or an application-defined signal or

dual tone

perform call progress analysis (CPA) to determine the state of an incoming

call

NOTE: Dialogic^®PBX Integration Boards only support CPA when used in

the default routing configuration. For instance, if a voice resource of

a Dialogic^®D/82JCT-U Board is listening to a front end other than

the default (its own), it may return a disconnected result. This is

because these boards support the call progress analysis feature of

dx_dial( ), but only when a board is using the default TDM routing.

In other words, PBX Integration Board voice resources cannot be

used to provide CPA capability for other boards.

For outbound calls, the PBX Integration Board can perform the following:

•

play stored compressed audio files

adjust the volume and speed of playback upon application or user request

generate tones - DTMF, MF, or an application defined signal or dual tone

The PBX Integration Board functions as a Dialogic^®D/41D Board with

specialized PBX circuitry replacing the analog front end. The PBX Integration

Board performs features available on a Dialogic^®D/41D and D/42-xx Board, as

well as emulates phones connected to a PBX. With the D/42-xx PBX Integration

Boards, it is necessary to choose a particular board depending on which PBX you

plan to use. With the Dialogic^®PBX Integration Board, however, a single board

can work with several different PBXs, with the software configuration selected to

reflect the PBX in use.

If recording speech, the Dialogic^®PBX Integration Board digitizes it as Pulse

Code Modulation (PCM), Adaptive Differential Pulse Code Modulation

(ADPCM), GSM 610, or G.726. The digitizing rate is selected on a channel-by-

channel basis and can be changed each time a record or play function is initiated.

The processed speech is stored on the host PC’s hard disk. If playing back a

stored file, the voice information from the host PC is passed to the PBX

Integration Board where it is converted into analog voice signals for transmission

to the PBX.

The on-board control processor controls the operations of the PBX Integration

Board via a local bus and interprets and executes commands from the host PC.

3. PBX Integration Overview

This processor handles real-time events, manages data flow to the host PC to

provide fast system response time, enables reduced PC host processing demands,

processes DTMF and PBX signaling before passing them to the application, and

frees the DSP to perform signal processing. Communication between this

processor and the host PC is via the shared buffer memory that acts as an

input/output buffer and thus can increase the efficiency of disk file transfers. This

shared buffer memory interfaces to the host PC via the PCI bus.

3.2. PBX Integration Features Supported

Dialogic^®PBX Integration Boards incorporate both circuitry and firmware to

integrate applications with specific PBXs. The Dialogic^®Unified API, used with

the PBX Integration Board, enables programmers to more easily develop a single

application capable of supporting multiple manufacturers’ PBXs. The Unified

API also enables applications to access the important digital information sent

between a PBX and its station sets. This information can be useful in a variety of

applications, including Voice Mail and Call Center.

3.2.1. Dialogic^®Unified API

The Dialogic^®Unified API (Application Programming Interface) allows a single

application to function on a variety of manufacturers’ switches. Functioning as an

extension to the standard Dialogic^®Voice API, the Unified API offers a single

design model that allows developers to utilize advanced PBX features (such as

called/calling number ID and ASCII display information).

•

Called/Calling number ID - usually two sets of digits representing either a

trunk line or an extension. This is not to be confused with caller ID received

from a CO, which provides the telephone number of an outside caller. It is

important for an application to know where a call originated and to what

extension it is intended. If a call is transferred (or “bounced”) through a

PBX, this information may be needed by an application at the final

destination. If it is needed and not present, the originator (if they are still

connected) will have to re-enter the information.

•

Retrieve LCD/LED prompts and indicators - Different PBXs have

different types of prompts and indicators that relay status information of the

station set. By capturing and processing this data, an application can “see”

what prompts or indicators have been set.

Dialogic^®PBX Integration Board User’s Guide

•

Read displays - There are many types of information displayed on a phone;

for instance, hook state, messages, features, and other ASCII text. By

capturing and processing this data, an application can “see” what is on the

display. This can help determine the state of the Dialogic^®PBX Integration

Board. Also, if ANI and DNIS digits are available through the PBX, the CO

caller ID can be obtained. Display data also can be useful when programming

a PBX. Because the PBX Integration Boards allow applications to “press”

buttons, applications can be written to program the PBX in the same way as

using a station set to program the PBX.

•

Accessing PBX features using dial strings - The Dialogic^®PBX Integration

Board allows applications to access features that are available through a

station set. These functions include call transfer, hold, setting the message

waiting indicator, and dialing programmable keys.

Disconnect supervision - When a PBX detects a hang-up from one of its

extensions, information is passes to the CO, which in turn hangs up.

Typically this is accomplished using a loop current drop. However, if the CO

hangs up first, a loop current drop is sent to the PBX but is not passed to the

station set. Instead, the station set receives a disconnect message. The

Dialogic^®PBX Integration Board interprets this disconnect message as a loop

current drop event. Not all PBXs support disconnect supervision.

Utility functions included in the Dialogic^®Unified API allow programmers to

control the Dialogic^®PBX Integration Board. Your application can retrieve the

PBX integration channel and board type, obtain and set PBX integration channel

and board parameters, retrieve Dialogic^®D/42 firmware/driver/library version

numbers, and retrieve error information.

Using the Dialogic^®Unified API to determine the type of switch to which the

Dialogic^®PBX Integration Board is connected enables programmers to create an

application that can provide specific control for each PBX. Specific control can

be accomplished using dial strings. Some examples are call transfer, call forward,

message waiting light manipulation, and pressing console buttons. The PBX

Integration Board is capable of performing most functions that are available to a

telephone connected to the PBX.

Developers who wish to continue designing switch-specific applications can

choose to do so, as the Dialogic^®Unified API also provides access to lower-level

function calls made available through each individual switch protocol. And for

3. PBX Integration Overview

customers unwilling to shift from older PBX integration development models, the

Unified API provides for backward compatibility, preserving their development

investment.

3.3. Dialogic^®PBX Integration Board Description

The Dialogic^®PBX Integration Board is a PCI form factor voice/fax processing

board that can interface directly to several different types of PBXs. The PBX

Integration Board emulates telephones that connect to the supported PBXs.

Application programs using the PBX Integration Board can answer incoming

calls, place outbound calls, record and playback voice files, detect and generate

tones, access the called/calling number ID for calls forwarded or transferred from

within the PBX, access trunk ID for calls originating outside the PBX, send and

receive faxes, and control message notification. The PBX Integration Board also

provides positive disconnect supervision to immediately detect when a caller has

hung up.

If used with one of the supported PBXs, the PBX Integration Board can provide a

flexible platform for developing integrated computer telephony applications.

Developers can integrate current Dialogic^®D/4x applications on the PBX

Integration Board with few software modifications and create efficient

applications for the PBX by offering value-added features.

A Dialogic^®PBX Integration Board has either four or eight channels that can be

connected directly to a supported PBX.

3.3.1. Features

Dialogic^®PBX Integration Board features include:

•

voice board with four or eight independent four-wire interfaces to a PBX,

thereby enabling reduced cost and complexity of application integration

interfaces directly to various PBXs

emulates telephones

automatically answers calls

detects Touch Tones

plays voice messages to a caller

digitizes, compresses, and records voice signals

•

Dialogic^®PBX Integration Board User’s Guide

•

places outbound calls and automatically reports the result

retrieves called/calling number ID to enable calls to be intelligently handled

activates/deactivates message waiting indicators to provide message

notification

•

supports two fax channels at any given time

allows supervised (recommended) and blind transfers for automated

attendant applications

•

provides positive disconnect supervision to immediately detect when a caller

has hung up

enables development of applications across a variety of PBX systems using

the unified API.

3.3.2. Functional Description

The Dialogic^®PBX Integration Board can connect to several different PBXs,

each of which has one or more compatible telephones with which it

communicates. The PBX Integration Board can emulate these telephones, which

have Feature Keys and LCD displays for accessing and employing advanced

features of the compatible PBXs.

Each of the four or eight line interfaces on Dialogic^®PBX Integration Boards can

receive voice and control data from the connected PBX. The voice data is

compressed by a DSP using one of the available encoding methods and then sent

to the host PC to be stored.

Control data from the PBX switch passes through the digital duplexer on the

Dialogic^®PBX Integration Board to a command processor, where it is converted

from its native format. The resulting serial bit stream is then converted into a

parallel bit stream that is sent via the local bus to the on-board control processor,

which either acts on the information or passes the event to the application (see

Figure 1).

3. PBX Integration Overview

H.100

Bus

Address Bus

Data Bus

100 MHz Onyx

DSP with 256K x

24 SRAM with

2 Wait States

CT812 Time

Slot

Interchange

PCI9052

Interface

TDM

Signals

Control

Lines

PCI Bus

Interface

Glue Logic

FPGA

Front End

PBX

Configuration Data

Figure 1. Dialogic^®PBX Integration Board Functional Block Diagram

Voice files stored on the host PC are read by the host driver and transferred to the

Dialogic^®PBX Integration Board via the PCI Bus. These voice signals are

buffered by the control processor and decoded into 64 Kbps PCM signals by the

DSP. These PCM voice signals are then sent to the PBX interface link for

transport to the caller. A system-wide, TDM signal sharing bus, called CT Bus, is

also provided for the exchange of signal streams with other resource boards,

signal transport boards, or other interfaces.

In addition to having all the standard features of a Dialogic^®D/41D Board, the

Dialogic^®PBX Integration Board can access enhanced PBX features, when

available, such as:

•

call transfer/conference

turn phone message waiting indicators on or off

callback request

calling number identification (Calling Number ID).

The Dialogic^®PBX Integration Board has an on-board microprocessor and a

high-speed Digital Signal Processor (DSP) to provide voice and call processing.

Dialogic^®Springware voice processing firmware is downloaded from the host

Dialogic^®PBX Integration Board User’s Guide

computer to SRAM and DSP memory when the Dialogic^®PBX Integration Board

is started. Dialogic^®Springware firmware offers several features, including speed

control, volume control, global tone detection, and positive voice detection.

Global tone detection allows applications to detect special intercept tones, fax

tones, modem tones, and non-standard PBX or user-defined tones, such as those

used in international networks.

Other DSP-based Dialogic^®Springware firmware features include G.711 A-law

and µ-law PCM, ADPCM, GSM 610, and G.726 voice encoding. An application

may dynamically switch between sampling rates and coding methods to meet

specific requirements for voice quality and data storage. Enhanced algorithms

provide reliable DTMF detection, DTMF cut-through, and talk off/play off

suppression.

3.3.3. Configurations

The Dialogic^®PBX Integration Board can connect to a line circuit board in a

supported PBX to help build a sophisticated, computer telephony system. The

PBX Integration Board installs in a platform with a minimum 90 MHz Pentium

processor or the equivalent Celeron processor with an available PCI bus slot for

an 8-port system. The host system must provide a Pentium or Celeron class

processor at 266 MHz speed or higher for a 64-port system, including eight

available PCI slots. The PBX Integration Board occupies a single expansion slot,

and up to eight boards can be configured in a system, with each board sharing the

same interrupt level. The maximum number of ports supported is 64, dependent

on the application, the amount of disk I/O required, and the host computer’s CPU.

The Dialogic^®PBX Integration Board shares many common hardware and

firmware architectures with other Dialogic^®products for a wide array of

flexibility and scalability. Features can be added or systems can grow while

protecting investment in hardware and application code. With only minimum

modifications, applications can be easily ported to lower or higher line-density

platforms.

3.3.4. Software Support

The Dialogic^®development package includes libraries, drivers, and headers to

enable quick and easy PBX integration. Diagnostics and demo programs provide

3. PBX Integration Overview

additional tools and examples that allow developers who choose to do so to create

complex multi-channel voice applications.

4. PBX Systems

4.1. Avaya Definity PBXs

The Avaya Definity product family includes the Definity 75 (4-wire) and the

Definity G3 (2-wire) PBXs. The Dialogic^®PBX Integration Board can be

used with either of these switches. The PBXs use digital signaling to control

their station sets and digitized voice.

A Dialogic^®PBX Integration Board has either four or eight channels that can

be connected directly to a station module in an Avaya PBX. The PBX switch

has many standard features that are supported by the PBX Integration Board,

such as:

•

direct inward dialing (DID)

speed dialing

hunt groups

message waiting indication

user programmable Feature Keys

called/calling number identification

call forwarding

4.1.1. Avaya Switch Programming Requirements

There are specific switch programming requirements that apply if using a

Dialogic^®PBX Integration Board with an Avaya Definity PBX. Pay attention

to configure the PBX properly so that the PBX Integration Board can function

correctly.

Port Number Settings

Each board in an Avaya PBX is assigned a port number. The number of ports

varies according to the board type (2-wire or 4-wire). A 2-wire board has 16

ports, whereas the 4-wire board has eight.

Dialogic^®PBX Integration Board User’s Guide

Table 1 lists the structure used if configuring an Avaya Definity PBX. For

details about programming an Avaya PBX, refer to the appropriate Avaya

manual.

The following are examples of the switch settings:

Table 1. Avaya Definity Configuration Example

Slot Board

Telephone Extension

Type Numbers

Port

Settings

Type

TN2181 2-wire 8434D

TN754B 4-wire 7434D

1000-1015 01A0301-01A0316

1016-1031 01A0401-01A0416

1032-1039 01A0501-01A0508

1040-1047 01A0601-01A0608

1048-1055 01A0701-01A0708

1056-1063 01A0801-01A0808

The settings above can be tailored according to your specific needs.

Message Waiting Light Settings

You must make certain settings from an Avaya management terminal for

Message Waiting Indicator (MWI) features to work correctly.

1. Login to switch from a management terminal.

2. Type command ‘CH STAT <ext>’ where ext is the extension of a

Dialogic^®PBX Integration Board port.

On the Avaya phone sets, go to the Button Assignments page and set

button 32 to ‘lwc-store’ and button 33 to ‘lwc-cancel’.

NOTE: If these features are programmed into any other button, they

must be removed, as there may be only one occurrence of these

features per extension.

3. Repeat as necessary for other extensions.

4. PBX Systems

Caller ID Requirement

The extension number must be included in the name field of the extension.

This requires PBX programming.

4.1.2. Using the Dialogic^®PBX Integration Board

The Dialogic^®PBX Integration Board can perform functions available to

Avaya 7434 (4-wire) and 8434 (2-wire) telephone sets (see Figure 2 and

Figure 3). These telephone sets use two LED displays per Feature Button to

show status (next to the Feature Buttons) and an LCD display to show user

prompts and messages (above the display buttons). The PBX Integration

Board can:

•

transfer calls

set the message waiting indicator

read the LED display

read LED indicators

read the called/calling number ID

press keys

Dialogic^®PBX Integration Board User’s Guide

on/off

Feature

Buttons

Indicators

Conf

Transfer

Hold

Drop

Message

Select

Figure 2. Avaya 7434 Telephone

4. PBX Systems

Display

Buttons

Feature

Buttons

Indicators

Function Keys

Figure 3. Avaya 8434 Telephone

4.1.3. Programmable Feature Keys

As illustrated in Figure 2 and Figure 3, there are 34 Programmable Feature

Keys found on the Avaya 7434 and 8434 telephones. These keys are

configured either during installation or by the user (using the telephone set or

the Dialogic^®PBX Integration Board). There are two LED indicators

associated with each Feature Button. The PBX Integration Board can also

emulate four Avaya Functions Keys: Transfer Conference, Drop, and Hold.

As mentioned above, each line or Feature Key actually has two indicator

lights. The red indicator tells the user that the line is being used or that the line

will be the one used when the handset is lifted. The green indicator (bottom on

the 8434 and right on the 7434) tells the user that the line or feature is in use.

In other words, when you pick up the handset or press a Feature Key, the

green indicator goes on. When a call is on hold, the green indicator for that

line flashes and the red indicator goes off. The red light is either off or on (a

Dialogic^®PBX Integration Board User’s Guide

value of eight [0x08] indicates ON), while the green light has six possible

values. The status of the indicators is obtained by bitwise-ANDing the

returned value from the green light with the value from the red light (green

light value + red light value). In other words, the value for a line indicator in

use with a call (after ANDing with 0x0f, all the values shown below in the

least significant byte value) would be nine--0x08 (for red light on) + 0x01 (for

green light on). The status conditions for each byte (least significant) of the

green light are defined as indicated in Table 2.

Table 2. Avaya 7434 and 8434 LED Indicator States

State

off

Value (Hex)

0x00

0x01

0x02

ringing

hold

0x03

0x04

error

unknown

0x05

Reading LED Indicators

The Dialogic^®PBX Integration Board can determine the state of its LED

indicators by using the d42_indicators( ) function to retrieve the LED

indicators data. This function places the Line Indicator data (34 bytes) in an

application buffer. Bytes 1-34 contain the indicator status for Memory Keys

00-33, respectively (see Table 3).

Table 3. Avaya 7434 and 8434

Direct Key Dialing Strings for Feature Keys

Byte Key Description

Dial String

<ESC>KA

<ESC>KB

<ESC>KC

Feature Button 00

Feature Button 01

Feature Button 02

4. PBX Systems

Byte Key Description

Dial String

Feature Button 03

Feature Button 04

Feature Button 05

Feature Button 06

Feature Button 07

Feature Button 08

Feature Button 09

Feature Button 10

Feature Button 11

Feature Button 12

Feature Button 13

Feature Button 14

Feature Button 15

Feature Button 16

Feature Button 17

Feature Button 18

Feature Button 19

Feature Button 20

Feature Button 21

Feature Button 22

Feature Button 23

Feature Button 24

Feature Button 25

Feature Button 26

Feature Button 27

Feature Button 28

Feature Button 29

Feature Button 30

<ESC>KD

<ESC>KE

<ESC>KF

<ESC>KG

<ESC>KH

<ESC>KI

<ESC>KJ

<ESC>KK

<ESC>KL

<ESC>KM

<ESC>KN

<ESC>KO

<ESC>KP

<ESC>KQ

<ESC>KR

<ESC>KS

<ESC>KT

<ESC>KU

<ESC>KV

<ESC>KW

<ESC>KX

<ESC>KY

<ESC>KZ

<ESC>Ka

<ESC>Kb

<ESC>Kc

<ESC>Kd

<ESC>Ke

Dialogic^®PBX Integration Board User’s Guide

Byte Key Description

Dial String

<ESC>Kf

<ESC>Kg

<ESC>Kh

Feature Button 31

Feature Button 32

Feature Button 33

Example

An application uses the d42_indicators( ) function to retrieve the current data

for the LED indicators on a given channel on a Dialogic^®PBX Integration

Board. The data placed in the application buffer is shown below. If the data

for byte 19 is 0x09 and byte 28 is 0x03, the red and green indicators are on for

Feature Button 19, indicating that the line is in use for a call, and the green

indicator for Memory Button 28 is flashing, indicating that the call is on hold.

Refer to the Dialogic^®PBX Integration Software Reference for more

information about using the d42_indicators( ) function.

Data 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 09 00 00 00 00

Byte 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23

Data 00 00 00 00 03 00 00 00 00 00 xx xx xx xx xx xx xx xx xx xx xx xx xx xx

Byte 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

NOTE: The application can obtain the least significant byte of the value

returned by the d42_indicators( ) function by ANDing that value

with 0x0f.

4. PBX Systems

Pressing Feature Keys

The Dialogic^®PBX Integration Board can “press” any of the Avaya 7434 or

8434’s Feature Keys using the dx_dial( ) function. Refer to the Dialogic^®

PBX Integration Software Reference for more information about dialing

programmable keys. Each Feature Button on the 7434 and 8434 telephones is

assigned a dial string sequence (refer to Table 3). By using the dx_dial( )

function and the appropriate dial string, the PBX Integration Board can press

any Feature Button.

4.1.4. Avaya Function Keys

Avaya telephones also include Function Keys that the Dialogic^®PBX

Integration Board can emulate to perform various functions. The PBX

Integration Board can emulate four Avaya Functions Keys: Transfer,

Conference, Drop, and Hold.

Pressing Function Keys

The Dialogic^®PBX Integration Board can “press” Avaya telephone Function

Keys using the dx_dial( ) function. The Function Keys on the Avaya 7434

and 8434 telephones assigned a dial string sequence are listed in Table 4. By

using the dx_dial( ) function and the appropriate dial string, the PBX

Integration Board can dial these four Avaya Function Keys. Refer to the

Dialogic^®PBX Integration Software Reference for more information about

dialing programmable keys.

Table 4. Avaya 7434 and 8434 Direct Key Dialing Strings for

Function Keys

Dial String

<ESC>Ki

<ESC>Kj

<ESC>Kk

<ESC>Kl

Key Description

Hold

Drop

Transfer

Conference

Dialogic^®PBX Integration Board User’s Guide

4.1.5. Display Keys

As shown in Figure 3, there are five Display Keys located below the LCD

display. These keys are associated with specific prompts shown on the LCD

display depending on the current state of the phone (shown on the bottom row

of the LCD display). The Dialogic^®PBX Integration Board cannot use the two

bottom, right-most Keys, Prev and Next.

Pressing Display Keys

The Dialogic^®PBX Integration Board can respond to a prompt and “press” the

appropriate Display Key using the dx_dial( ) function. Refer to the Dialogic^®

PBX Integration Software Reference for more information about dialing

programmable keys. Each Display Key on the Avaya 8434 telephone is

assigned a dial string sequence (refer to Table 5). By using the dx_dial( )

function and the appropriate dial string, the PBX Integration Board can press

any of its first seven Display Keys.

Table 5. 8434 Direct Key Dialing Strings for Display Keys

Dial String Key Description

<ESC>Km Display Key 00

<ESC>Kn

<ESC>Ko

<ESC>Kp

<ESC>Kq

<ESC>Kr

<ESC>Ks

Display Key 01

Display Key 02

Display Key 03

Display Key 04

Display Key 05

Display Key 06

4.1.6. Alphanumeric Display

The alphanumeric display is a two row, 50-digit LED that is used to show the

activity of the phone. Some examples are:

•

date and time

feature names

4. PBX Systems

•

error messages

called/calling identification

phone status

line selection

Display Key prompts

The data used to display information in the LED alphanumeric display is in

ASCII format. When the telephone is not in use, the display normally shows

the date and time. The content of the display is changed automatically (e.g.,

receiving an incoming call, making an outgoing call, or activating a feature).

The Dialogic^®PBX Integration Board can retrieve the information on its

alphanumeric display using the d42_displayex( ) function. The function

places the display data (50 bytes) in an application buffer. Refer to the

Dialogic^®PBX Integration Software Reference for more information about

using the d42_displayex( ) function.

Example

An application uses the dx_dial( ) function and the appropriate dial string to

press keys to dial extension number 1045. The d42_display( ) function is used

to retrieve the display data and place it in an application buffer (shown below).

The information for the top row (last 25 characters) of the display is checked.

Data in bytes 00 through 05 indicate that extension 1045 is being dialed.

data 61 3D 01 00 04 05 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20

byte 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23

data 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20

byte 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

Called/Calling Number ID (within the PBX)

If receiving a call on a Dialogic^®PBX Integration Board from another

extension, the PBX sends calling number ID data (by default, the extension

Dialogic^®PBX Integration Board User’s Guide

number of the telephone placing the call) to the station set between the first

and second rings. The station set processes the data and sends an ID message

to the display. The calling number ID data sent from the PBX to the station set

differs from the calling number ID data presented on the display.

When placing a call to another extension, the called number ID (by default,

the extension of the telephone being called) is shown in the display.

Both the calling and called number IDs can be retrieved using the

d42_gtcallid( ) function. The d42_gtcallid( ) function retrieves the

called/calling number ID message sent from the PBX to the station set, not the

data sent to the display. Refer to the Dialogic^®PBX Integration Software

Reference for more information about using d42_gtcallid( ) function.

The contents of the called/calling number ID are shown in Table 6 as seen by

the receiver of the call).

Table 6. Called/Calling Number ID Data for the Avaya Definity

Call Route

Called/Calling Number ID

Data

Call received from station set 221

_221

Call originally received by extension

221, then forwarded to extension 224

224_221

Call originally received by extension 221 221_761-621-8090

from trunk line 1, then forwarded to

D/82 (where trunk line 1 presents ANI

information, e.g., 716-621-8090)

NOTE: The called/calling number ID can also be obtained using the

d42_displayex( ) function and parsing the display in the application.

However, you can use the d42_gtcallid( ) function so that your

application will maintain functionality across different

manufacturers’ switches.

4. PBX Systems

Example

An application uses the d42_gtcallid( ) function to retrieve the calling number

ID for a call received on a specified channel on a Dialogic^®PBX Integration

Board. The calling number ID data and corresponding ASCII values are

shown below.

text

data

byte

bb 2 2 4 _ 2 2 1

20 32 32 34 5F 32 32 31 xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

text

data

byte

xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

4.1.7. Setting the Message Waiting Indicator

The Dialogic^®PBX Integration Board can set the Message Waiting Indicator

(on or off) on another extension using the dx_dial( ) function and the

appropriate dial string. Refer to the Dialogic^®PBX Integration Software

Reference for more information about dialing programmable keys.

NOTE: Message Waiting can also be set using the dx_dial( ) function and

the appropriate dial string to press the Feature Key assigned to send

messages. However, you can use the dx_dial( ) function as described

so that your application will maintain functionality across different

manufacturers’ switches.

MWI On

A technique to turn on the MWI in this switch, using dx_dial( ) with the dial

string, is to:

1. Go off-hook using dx_sethook( ) function.

2. Call the dx_dial() function. The dial string is

<ESCO><extension><ESCO> (optional pause character may be used).

3. Go on-hook using the dx_sethook( ) function again

NOTE: <ESCO> means the Escape character followed by O.

Dialogic^®PBX Integration Board User’s Guide

MWI Off

A technique to turn off the MWI in this switch, using dx_dial( ) with the dial

string, is to:

1. Go off-hook using dx_sethook( ) function.

2. Call the dx_dial( ) function. The dial string is

<ESCF><extension><ESCF> (optional pause character may be used).

3. Go on-hook using the dx_sethook( ) function again.

NOTE: <ESCF> means the Escape character followed by F.

4.1.8. Transferring a Call

The Dialogic^®PBX Integration Board can transfer calls using the dx_dial( )

function. By using the dx_dial( ) function and the appropriate dial string, the

PBX Integration Board can transfer a call to any extension connected to the

switch. Refer to the Dialogic^®PBX Integration Software Reference for more

information about dialing programmable keys.

The Dialogic^®PBX Integration Board can perform both supervised and blind

transfers (refer to Sections 2.1. Supervised Call Transfer and 2.2. Blind Call

Transfer). If a blind transfer is performed, the PBX controls where the call is

routed if the extension is busy or does not answer. If a supervised transfer is

performed, your application can implement call progress analysis and

called/calling number ID to intelligently control where the call is routed (by

completing or aborting the transfer) and what type of message is played if the

called extension is busy or does not answer. Because of this capability,

supervised transfer is a comparatively preferred call transfer method.

Initiating the Transfer

Once in a connected call, you can initiate a transfer with dx_dial(&,<ext>),

where & acts as a key press of the transfer key and <ext> is the PBX

extension to which you are transferring the call.

4. PBX Systems

Completing the Transfer

To complete a call (supervised or blind), press the transfer key again with

dx_dial(&), where & acts as a key press of the transfer key. The application

must handle the on-hook state after completing the transfer.

Aborting the Transfer

A transferred call can be aborted at any time (prior to completing the transfer)

by pressing the appropriate appearance key where the original call resides.

The application can perform this only in a supervised transfer mode. For

example, if the original call resided on the first appearance (Feature Key 00),

dialing dx_dial(<ESC>KA) will bring the original caller back to an active

state.

Example

An application answers a call and plays a greeting message prompting the

caller to enter the extension they wish to reach (the caller enters 221). Using

the dx_dial( ) function with the dial string (&,221), the application attempts to

transfer (supervised) the call to extension 221. Call progress analysis is used

to determine if extension 221 is answered, busy, or there is no answer. If

extension 221 answers, the application needs to use dx_dial( ) to press &

again to complete the transfer and hang up after the transfer is complete. If the

extension is busy or not answered, the application reconnects to the incoming

call and plays a message asking the caller to choose between accessing voice

mail or transferring to the operator.

Dialogic^®PBX Integration Board User’s Guide

4.2. Siemens ROLM PBX

The ROLM product family includes three generations of ROLM and related

PBXs:

1. The original ROLM

2. IBM ROLM 9751 series

3. Siemens Hicom 300 with the appropriate interface cards

The Dialogic^®PBX Integration Board emulating the ROLM 400 telephone

can be used with these switches. The ROLM PBXs use digital signaling to

control their station sets and digitized voice.

The Dialogic^®PBX Integration Board has either four or eight channels that

can be connected directly to a station module in a Siemens ROLM PBX. The

PBX switch has many standard features that are supported by the PBX

Integration Board, such as:

•

direct inward dialing (DID)

speed dialing

hunt groups

message waiting indication

user programmable feature keys

called/calling number identification

call forwarding

4.2.1. Siemens ROLM Programming Requirements

There are specific switch programming requirements that apply if using a

Dialogic^®PBX Integration Board with a Siemens ROLM PBX. Pay attention

to set these features exactly (and assigned to the right keys) so that the PBX

Integration Board and the Dialogic^®Unified API can function correctly.

•

All PBX Integration Board ports on a ROLM system must be

programmed as ROLMphone 400 telephones.

LINE must be programmed on Feature Key 09, and the ROLMphone

must be programmed to select this line when going off-hook.

4. PBX Systems

•

XFER (transfer) must be programmed on Feature Key 38.

MWI (Message Waiting Indication) mechanisms are different with

ROLM CBX 9006 (or ROLM integration on the Hicom 300) and ROLM

CBX 9005 PBX.

For ROLM CBX 9006 PBX or ROLM integration on the Hicom 300

For the ROLM CBX 9006 PBX or ROLM integration on Hicom 300, the

following programming requirements apply:

•

DDS (speed dial) must be programmed on Feature Key 03 for the correct

message waiting “ON” feature access code, which is *59 (default, but is

dependent on the PBX setup. Consult the PBX administrator for the

correct feature access code) if you are using the ROLM integration on the

Hicom 300 or if you are using the ROLM CBX 9006 PBX. To program

this key on the ROLMphone:

1. Press PROG (Feature Key 20).

2. Then press Feature Key 03.

3. Dial *59 (or the correct PBX dependent Feature Access Code), and

press PROG again.

4. The phone display indicates “STORED” and message-waiting light

(or Mailbox indicator light) ON is now set for Feature Key 03.

•

DDS (speed dial) must be programmed on Feature Key 04 for the correct

message-waiting OFF feature access code, which is #60 (default, but is

dependent on the PBX setup. Consult the PBX administrator for the

correct feature access code) if using the ROLM integration on the Hicom

300 or if you are using the ROLM CBX 9006 PBX. To program this key

on the ROLMphone:

1. Press PROG (Feature Key 20).

2. Then press Feature Key 04.

3. Dial #60 (or the correct PBX dependent Feature Access Code), and

press PROG again.

4. The phone display indicates STORED and message-waiting light (or

Mailbox indicator light) OFF is now set for Feature Key 04.

Dialogic^®PBX Integration Board User’s Guide

For ROLM CBX 9005 PBX

For the ROLM CBX 9005 PBX, the following programming requirements

apply:

•

In this case the MWI ON/OFF key is a toggle key and it must be

programmed to be the Feature Key 37.

NOTES: 1. For transferred calls, the called-party ID appears as a direct call

because the PBX does not write the called-party ID to the

display.

2. For message waiting, only the port that sets a message-waiting

indicator can clear it.

3. With all switches supporting ROLMphone 400, the asynchronous

event TD42_ASYNCCHSTATUS for reporting carrier gain is

only received once, when the board starts and the port is

connected to the switch. If the port is disconnected and connected

again, the application does not receive any other carrier loss and

gain events.

4.2.2. Using the Dialogic^®PBX Integration Board

The Dialogic^®PBX Integration Board performs functions available to a

ROLMphone 400 telephone set (see Figure 4). A ROLMphone 400 telephone

set uses an LED display to show key status (next to the keys) and user

prompts and messages on the display to provide various options. The PBX

Integration Board can:

•

transfer calls

set the message waiting indicator

read the LCD display

read LED indicators

read the called/calling number ID

press keys

4. PBX Systems

Display

Indicators

MWI

PROG

Feature Keys

CALL WAITING

CLEAR

SPKR

MUTE

XFER

LINE

Figure 4. Siemens ROLMphone 400

4.2.3. Programmable Feature Keys

As illustrated in Figure 4, there are 40 Feature Keys located below the display

on the ROLMphone 400 telephone. These keys are configured either during

PBX installation or by the user (using the telephone set or the Dialogic^®PBX

Integration Board). The CLEAR, SPEAKER, MUTE, XFR, and LINE keys

are assigned during PBX configuration and cannot be user programmed. The

MAILBOX indicator is programmed on each phone (see 4.2.1. Siemens

ROLM Programming Requirements above) for Feature Key 01. Feature Keys

39 and 40 are used for volume control and cannot be programmed either.

There is an LED indicator associated with each key, except those discussed in

the following paragraph. The LED indicators are circular and can take on one

of the six states listed in Table 7.

Dialogic^®PBX Integration Board User’s Guide

Table 7. ROLMphone 400 LED Indicator States

State

off

Value (Hex)

0x00

0x01

ringing

hold

0x02

0x03

error

unknown

0x04

0x05

Reading LED Indicators

The Dialogic^®PBX Integration Board can determine the state of its LED

indicators by using the d42_indicators( ) function to retrieve the LED

indicators data. This function places the LED indicator data (37 bytes) in an

application buffer. Bytes 00-36 contain the indicator status for Feature Keys

01-37, respectively (see Table 8). As indicated in the example below, Feature

Keys 10, 30, and 38-40 do not have LED indicators.

4. PBX Systems

Table 8. ROLMphone 400 Direct Key Dialing Strings for Feature

Keys

Byte Key Description

Feature Key 09 - LINE

Dial String

<ESC>KA

<ESC>KB

<ESC>KC

<ESC>KD

<ESC>KE

<ESC>KF

<ESC>KG

<ESC>KH

<ESC>KI

<ESC>KJ

<ESC>KK

<ESC>KL

<ESC>KM

<ESC>KN

<ESC>KO

<ESC>KP

<ESC>KQ

<ESC>KR

<ESC>KS

<ESC>KT

<ESC>KU

<ESC>KV

<ESC>KW

<ESC>KX

<ESC>KY

Feature Key 08

Feature Key 07

Feature Key 06 - CLEAR (flash)

Feature Key 05

Feature Key 04

Feature Key 03

Feature Key 02

Feature Key 01 - MAILBOX

Feature Key 15

Feature Key 14

Feature Key 13

Feature Key 12

Feature Key 11

Feature Key 20 - PROG (program)

Feature Key 19

Feature Key 18

Feature Key 17

Feature Key 16

Feature Key 25

Feature Key 24

Feature Key 23

Feature Key 22

Feature Key 21

Feature Key 35

Dialogic^®PBX Integration Board User’s Guide

Byte Key Description

Dial String

<ESC>KZ

<ESC>Ka

<ESC>Kb

<ESC>Kc

<ESC>Kd

<ESC>Ke

<ESC>Kf

<ESC>Kg

<ESC>Kh

<ESC>Ki

<ESC>Kj

<ESC>Kk

<ESC>Kl

<ESC>Km

<ESC>Kn

Feature Key 34

Feature Key 33

Feature Key 32

Feature Key 31

Feature Key 29

Feature Key 28

Feature Key 27

Feature Key 26

Feature Key 37 - MWCTR*

Feature Key 36 - SPEAKER

Feature Key 40 - Volume Down

Feature Key 39 - Volume Up

Feature Key 10

Feature Key 30

Feature Key 38 - XFER

Call Waiting LED

*MWCTR = Message Waiting Control

Example

An application uses the d42_indicators( ) function to retrieve the current data

for the LED indicators on a given channel on a Dialogic^®PBX Integration

Board. The data placed in the application buffer is shown below. If the least

significant byte of the data for byte 00 is 0x01 (0x61 AND 0x0f = 0x01 in the

figure below), the circular indicator for Feature Key 09 is on. Refer to the

Dialogic^®PBX Integration Software Reference for more information about

using the d42_indicators( ) function.

4. PBX Systems

61 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00

Data

Byte 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23

00 00 00 00 00 00 00 00 00 00 00 00 xx xx xx xx xx xx xx xx xx xx xx xx

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

Data

Byte

NOTE: The application can obtain the least significant byte of the value

returned by the d42_indicators( ) function by ANDing that value

with 0x0f.

Pressing Feature Keys

The Dialogic^®PBX Integration Board can “press” any of the ROLMphone

400 Feature Keys using the dx_dial( ) function. Refer to the Dialogic^®PBX

Integration Software Reference for more information about dialing

programmable keys. Each Feature Key on the ROLMphone 400 telephone is

assigned a dial string sequence (refer to Table 8). By using the dx_dial( )

function and the appropriate dial string, the PBX Integration Board can press

any Feature Key.

4.2.4. Alphanumeric Display

The alphanumeric display is a two row, 60-character LCD that is used to show

the activity of the phone. Some examples are:

•

date and time

feature names

text messages

error messages

called/calling identification

Dialogic^®PBX Integration Board User’s Guide

•

phone status

line selection

The data used to display information in the LCD alphanumeric display is in

ASCII format. If the telephone is not in use, the display normally shows the

date and time. The content of the display is changed automatically (e.g.,

receiving an incoming call, making an outgoing call, or activating a feature).

The Dialogic^®PBX Integration Board can retrieve the information on its

alphanumeric display using the d42_display( ) function. The function places

the display data (48 bytes) in an application buffer. Refer to the Dialogic^®

PBX Integration Software Reference for more information about using the

d42_display( ) function.

Example

An application uses the dx_dial( ) function and the appropriate dial string to

press keys dial extension number 1045. The d42_display( ) function is used to

retrieve the display data and place it in an application buffer (shown below).

The information for the top row (first 30 characters) of the display is checked.

Data in bytes 00 through 03 indicate that extension 1045 is being dialed.

01 00 04 05 4C 4C 20 20 20 20 20 20 20 20 20 20 20 20 20 20

data

byte 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19

20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

data

byte

20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

data

byte

Called/Calling Number ID (within the PBX)

If receiving a call on a Dialogic^®PBX Integration Board from another

extension, the PBX sends calling number ID data (by default, the extension

number of the telephone placing the call) to the station set between the first

and second rings. The station set processes the data and sends an ID message

4. PBX Systems

to the display. The calling number ID data sent from the PBX to the station set

differs from the calling number ID data presented on the display.

If placing a call to another extension, the called number ID (by default, the

extension of the telephone being called) is shown in the display.

Both the calling and called number IDs can be retrieved using the

d42_gtcallid( ) function. The d42_gtcallid( ) function retrieves the

called/calling number ID message sent from the PBX to the station set, not the

data sent to the display. Refer to the Dialogic^®PBX Integration Software

Reference for more information about using d42_gtcallid( ) function.

The contents of the called/calling number ID are shown in Table 9 (as seen by

the receiver of the call).

Table 9. Called/Calling Number ID Data for the ROLM

Call Route

Called/Calling Number ID Data

Call received from station set 221

_221

Call originally received by extension

221, then forwarded to extension 224

224_221

NOTE: The called/calling number ID can also be obtained using the

d42_display( ) function; however, you can use the d42_gtcallid( )

function so that your application will maintain functionality across

different manufacturers’ switches.

Example

An application uses the d42_gtcallid( ) function to retrieve the calling number

ID for a call received on a specified channel on a Dialogic^®PBX Integration

Board. The calling number ID data and corresponding ASCII values are

shown below.

Dialogic^®PBX Integration Board User’s Guide

text

data

byte

bb 2 2 1 _ 2 2 4

20 32 32 31 5F 32 32 34 xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

text

data

byte

xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx xx

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

4.2.5. Setting the Message Waiting Indicator