PBX Integration board User s Guide

Transcription

1 PBX Integration board User s Guide for Linux and Windows Copyright 2001 Dialogic Corporation

2 COPYRIGHT NOTICE Copyright 2001 Dialogic Corporation. All Rights Reserved. All contents of this document are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation. Every effort is made to ensure the accuracy of this information. However, due to ongoing product improvements and revisions, Dialogic cannot guarantee the accuracy of this material, nor can it accept responsibility for errors or omissions. No warranties of any nature are extended by the information contained in these copyrighted materials. Use or implementation of any one of the concepts, applications, or ideas described in this document or on Web pages maintained by Dialogic may infringe one or more patents or other intellectual property rights owned by third parties. Dialogic does not condone or encourage such infringement. Dialogic makes no warranty with respect to such infringement, nor does Dialogic waive any of its own intellectual property rights which may cover systems implementing one or more of the ideas contained herein. Procurement of appropriate intellectual property rights and licenses is solely the responsibility of the system implementer. The software referred to in this document is provided under a Software License Agreement. Refer to the Software License Agreement for complete details governing the use of the software. All names, products, and services mentioned herein are the trademarks or registered trademarks of their respective organizations and are the sole property of their respective owners. DIALOGIC (including the Dialogic logo), DTI/124, and SpringBoard, are registered trademarks of Dialogic. A detailed trademark listing can be found at Publication Date: September, 2001 Part Number: Dialogic, an Intel company 1515 Route 10 Parsippany NJ USA Technical Support For Sales Offices and other contact information, visit the main Dialogic website at:

3 Table of Contents 1. How To Use This Manual Audience Product Terminology PBX Models Covered in this Manual Documentation Conventions Voice Hardware Covered by This Manual Voice Hardware Model Names When To Use This Manual How This Manual Is Organized Introduction to PBXs and KTSs Supervised Call Transfer Blind Call Transfer Caller ID Called Number ID Positive Disconnect Supervision In-Band Signaling Out-Of-Band Signaling Read Display Messages Pressing Keys Message Waiting Indication Automated Attendant PBX Integration Overview Voice Features Supported PBX Integration Features Supported Unified API PBX Integration Board Description Features Functional Description Configurations Software Support PBX Systems Lucent Definity PBXs Lucent Switch Programming Requirements Using the PBX Integration Board Programmable Feature Keys...26 iii

4 PBX Integration board User s Guide Lucent Function Keys Display Keys Alphanumeric Display Setting the Message Waiting Indicator Transferring a Call Siemens ROLM PBX Siemens ROLM Programming Requirements Using the PBX Integration Board Programmable Feature Keys Alphanumeric Display Setting the Message Waiting Indicator Transferring a Call Siemens Hicom PBX Siemens Hicom Programming Requirements Using the PBX Integration Board Programmable Feature Keys Alphanumeric Display Setting the Message Waiting Indicator Transferring a Call MITEL SUPERSWITCH PBXs MITEL SUPERSWITCH Programming Requirements Using the PBX Integration Board Programmable Personal Keys Function Keys Display Keys Alphanumeric Display Setting the Message Waiting Indicator Transferring a Call Nortel Norstar Nortel Norstar Programming Requirements Using the PBX Integration Board Programmable Memory Keys Display Keys Alphanumeric Display Setting the Message Waiting Indicator Transferring a Call Nortel Meridian Nortel Meridian 1 Programming Requirements Using the PBX Integration Board...95 iv

5 Table of Contents Programmable Feature Keys Alphanumeric Display Setting the Message Waiting Indicator Transferring a Call Appendix A - Technical Specifications Glossary Index v

6 PBX Integration board User s Guide vi

7 List of Tables Table 1. Lucent Definity Configuration Example...24 Table 2. Lucent 7434 and 8434 LED Indicator States...27 Table 3. Lucent 7434 and 8434 Direct Key Dialing Strings for Feature Keys...27 Table 4. Lucent 7434 and 8434 Direct Key Dialing Strings for Function Keys..30 Table Direct Key Dialing Strings for Display Keys...30 Table 6. Called/Calling Number ID Data for the Lucent Definity...32 Table 7. ROLMphone 400 LED Indicator States...39 Table 8. ROLMphone 400 Direct Key Dialing Strings for Feature Keys...40 Table 9. Called/Calling Number ID Data for the ROLM...44 Table 10. Optiset E LED Indicator States...54 Table 11. Optiset E Direct Key Dialing Strings for Feature Keys with Hicom 150E...54 Table 12. Optiset E Direct Key Dialing Strings for Feature Keys with Hicom 300E...55 Table 13. Called/Calling Number ID Data for the Hicom...58 Table 14. MITEL SUPERSET 400 Series LCD Line Indicator States...67 Table 15. MITEL SUPERSET 400 Series LCD Line Indicators and Dial Strings...67 Table 16. MITEL SUPERSET 420 Direct Key Dialing Strings for Function Keys...69 Table 17. MITEL SUPERSET 430 Direct Key Dialing Strings for Function Keys...69 Table 18. MITEL SUPERSET 420 Direct Key Dialing Strings for Display Keys...71 Table 19. MITEL SUPERSET 430 Direct Key Dialing Strings for Display Keys...72 Table 20. Called/Calling Number ID Data for the Hicom...74 Table 21. Norstar Configuration Requirements (DR5)...79 Table 22. M7324 LCD Indicator States...83 Table 23. M7324 Direct Key Dialing Strings for Memory Keys...84 Table 24. M7324 Direct Key Dialing Strings for Display Keys...87 Table 25. Called/Calling Number ID Data for the Nortel Norstar...90 Table 26. Nortel Meridian 1 Configuration Requirements...94 Table 27. M2616 LCD Indicator States...97 Table 28. M2616 Direct Key Dialing Strings for Feature Keys...97 Table 29. Called/Calling Number ID Data for the Meridian vii

8 PBX Integration board User s Guide viii

9 List of Figures Figure 1. PBX Integration board Functional Block Diagram...20 Figure 2. Lucent 7434 Telephone...25 Figure 3. Lucent 8434 Telephone...26 Figure 4. Siemens ROLMphone Figure 5. Siemens Optiset E Telephone with the Hicom 150E...52 Figure 6. Siemens Optiset E Telephone with the Hicom 300E...53 Figure 7. Optiset E Message Waiting Display with Hicom 150E...61 Figure 8. MITEL SUPERSET 400 Series Telephone...66 Figure 9. MITEL SUPERSET LCD Line Indicator...68 Figure 10. MITEL SUPERSET 420 Display Keys...71 Figure 11. Nortel M7324 Telephone...83 Figure 12. M7324 Display Keys...87 Figure 13. M7324 Message Waiting Display...92 Figure 14. Nortel M2616 Telephone...96 ix

10 PBX Integration board User s Guide x

11 1. How To Use This Manual 1.1. Audience This manual is addressed to programmers and engineers who are computer-literate and are interested in using Dialogic PBX Integration boards and the Dialogic Unified API 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 the end-user of your application program Product Terminology This manual includes information about using your 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. For businesses, the key advantage to owning a PBX is the efficiency and cost savings of sharing a specific number of telephone lines among a large group of users. Grouped with PBXs are KTSs, which are generally smaller versions of a PBX that provides direct access to CO telephone lines. For simplicity, the term PBX will be used to denote both a PBX and KTS. In the PBX environment a line from the CO is called a trunk and a phone is called a line, extension, or station PBX Models Covered in this Manual This manual includes support for the following PBXs and KTSs and associated telephones: Manufacturer PBX Hardware Telephone Emulations Lucent Definity System 75/ (4-wire) Definity System G3 Ver (2-wire) Siemens ROLM 9005 and 9006 ROLMphone 400 (RP400) Hicom 150E and 300E Optiset E Mitel SX-50 Superset 420 (DNIC) 1

12 PBX Integration board User s Guide SX-200ML Superset 430 (DNIC) SX-2000 Nortel Norstar M7324 Meridian 1 M 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 is 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 byte(s) referenced in the example is shown in boldface. 2

13 1. How To Use This Manual 1.5. Voice Hardware Covered by This Manual The PBX Integration board voice hardware is designed to provide a set of costeffective tools for implementing computerized voice and call processing applications for PBXs. It provides the basic voice and call processing capabilities of D/4x voice hardware and adds hardware and firmware that eases integration with supported PBXs. The PBX Integration board hardware also provides access to PBX functions not normally available. Refer to the Voice Software Reference for your operating system for more information on voice and call processing. The PBX Integration hardware models covered by this manual include the following: D/42JCT-U an 4-channel voice board with station interfaces for connecting directly to a number of different PBXs. D/82JCT-U an 8-channel voice board with station interfaces for connecting directly to a number of different PBXs Voice Hardware Model Names Model names for Dialogic voice boards are based upon 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, represents board revision (D, E, J, etc.) BB TT bus type (SC or CT) telephony interface type (if applicable; valid entries include LS, T1, E1, BR, U {for universal PBX Interface) VVV ohm value (if it applicable; valid entries are 75 d 120) 3

14 PBX Integration board User s Guide and 120) Sometimes it is necessary in this document to refer to a group of voice boards rather than specific models, in which case an x is used to replace the part of the model name that is generic. For example, D/xxx refers to all models of the voice hardware, and D/8x refers to all 8-channel models When To Use This Manual This PBX Integration User s Guide contains information for configuring and using specific PBX hardware for use with PBX Integration boards. For information about installing hardware, refer to the PBX Integration Quick Install Card provided with your board. For information about installing PBX Integration software, refer to the System Release Software Installation Reference for your particular operating system. 4

15 1. How To Use This Manual 1.7. How This Manual Is Organized Chapter 1 How To Use This Manual describes the PBX Integration 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 PBX Integration products and a description of the Unified API. Chapter 4 PBX Configuration and Integration contains general descriptions, capabilities, switch requirements, and direct key dial sequences of all supported PBXs. Appendix A PBX Integration Specifications contains a data sheet for the PBX Integration circuit cards. Glossary contains a comprehensive list of definitions for commonly used terms. Index contains an alphabetical index of features and topics. 5

16

17 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. Key advantages to owning a PBX are: increased efficiency and cost savings because a specific number of CO telephone lines are shared among a large group of users special PBXs 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 less than 50 extensions are needed. Advantages of having a KTS are that anyone in your office can answer an incoming call simply by pressing the correct line button and 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. For simplicity, throughout this manual the term PBX will be used to denote a PBX, KTS, or hybrid system. Most 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 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 7

18 PBX Integration board User s Guide 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 that lets you access or transmit voice, fax, and messages from a single point 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 handling a large number of agents or telephone operators for processing requests for products, services or information 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 that can include information such as called/calling number ID. Out-of-band signals do not use the band of frequencies use by the voice signals. They can be transmitted using the same wires as the telephone set or separate wires (e.g., RS-232). Because of its versatility, out-of-band signaling is the preferred method. CT equipment comprises a PC containing a Dialogic PBX Integration board and a software application. A PBX Integration board, together with the Dialogic Unified 8

19 2. Introduction to PBXs and KTSs API, make it easier to create applications that are tightly integrated with a PBX and take advantage of call control elements. Below is a list of popular PBX features and functions supported by a Dialogic PBX Integration board. 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 is equivalent 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. While a supervised transfer can be implemented without a PBX Integration board (using hook flash), the availability and ease of implementation is inconsistent. By using a PBX Integration board and the appropriate dial string, you can initiate a 9

20 PBX Integration board User s Guide transfer the same way for all supported switches. Also, by incorporating call progress analysis, you can offer consistent, high-performance call transfer features in your 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 PBX Integration will only be transferred after a 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 original call 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 most voice mail applications. A blind call transfer is equivalent 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). The advantage of a 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. The only potential drawback of a blind transfer is when phone traffic is 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, by using a PBX Integration board and the 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. 10

21 2. Introduction to PBXs and KTSs 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 having to navigate through a series of menus for a second or third time Caller ID Caller ID is the phone number that identifies the person who is placing the call. These digits are typically transmitted at the beginning of a call, usually between the first and second ring. While telephone companies are beginning to sell a caller ID service to residential customers, the scope of this 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 powerful 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 is useful whenever you need to know who is calling and from where they are calling 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. When a call is 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, when a call has been routed through the PBX because the first intended extension was not answered or busy, the final destination answering the call can determine the extension that called plus the extension that was originally called. 11

22 PBX Integration board User s Guide 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: (trunk 01) Program B: (trunk 02) Program C: (trunk 03) Program D: (trunk 04) Using a PBX Integration board and the Unified API, an application can read the called number ID (the trunk line) and route the call depending on which extension receive 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 long list of prompts to obtain the four digit extension code to access Program A Positive Disconnect Supervision In any PBX phone system, it is important to accurately 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 more importantly 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 cannot interpret disconnect messages because these messages are usually digital. PBX Integration boards can, however, 12

23 2. Introduction to PBXs and KTSs detect disconnect messages and send a disconnect event to an application where it is used by the Dialogic 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 has no way of knowing when the caller has hung up so it can receive another call. 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 positive disconnect supervision 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, 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 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 the preferred method Read Display Messages Most 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 PBX Integration board, this information can be easily passed 13

24 PBX Integration board User s Guide unprocessed to the application. This means that the same data that is sent to the display is captured by a 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) is especially useful in CT applications because it enables an application to know exactly what state the extension connected to the PBX Integration board is in. 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 using a PBX Integration board to program the Nortel Norstar, display data is indispensable. 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 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 PBX Integration board emulates 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 to ensure that the environment has been set correctly Message Waiting Indication Most 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. Using a 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) 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. 14

25 3. PBX Integration Overview The PBX Integration board combines the voice and fax features available in the 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 call 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 PBX Integration board uses a dual-processor architecture comprising a DSP (Digital Signal Processor) and a general purpose microprocessor to handle all voice processing functions. This dual processor approach off loads many lowlevel 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 PBX Integration board. This downloadable firmware gives the board all of its intelligence and enables easy 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 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. 15

26 PBX Integration board User s Guide NOTE: PBX Integration boards only support CPA when used in the default routing configuration. For instance, if a voice resource of a D/82JCT-U 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( ), 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 is basically a D/41D board with specialized PBX circuitry replacing the analog front end. The PBX Integration board performs features available on a D/41D and D/42-xx, as well as emulating phones connected to a PBX. With the current D/42-xx PBX Integration boards, it is necessary to choose a particular board depending on which PBX you plan to use. With the PBX Integration board, however, a single board can work with several different PBXs, with the software configuration selected to reflect the PBX in use. When recording speech, the 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. When 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 all operations of the PBX Integration board via a local bus and interprets and executes commands from the host PC. This processor handles real-time events, manages data flow to the host PC to provide faster system response time, reduces 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 increases the efficiency of disk file transfers. This shared buffer memory interfaces to the host PC via the PCI bus. 16

27 3. PBX Integration Overview 3.2. PBX Integration Features Supported PBX Integration boards incorporate both circuitry and firmware to integrate applications with specific PBXs. The Unified API, used with the PBX Integration board, enables programmers to more easily develop a single application capable of supporting multiple manufacturer s PBXs. The Unified API also enables applications to access the important digital information sent between a PBX and its station sets. This information is useful in a variety of applications including Voice Mail and Call Center Unified API The Unified API (Application Programming Interface) allows a single application to function on a variety of manufacturers switches. Functioning as an extension to the Dialogic standard voice API, the Unified API offers a single design model that allows developers to take advantage of 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. When a call is transferred (or bounced ) through a PBX, this information may be needed by an application at the final destination. If it is 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. 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 is useful for determining the state of the PBX Integration board. Also, when ANI and DNIS digits are available through the PBX, the CO caller ID can be obtained. Display data is also 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. 17

28 PBX Integration board User s Guide Accessing PBX features using dial strings - The 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 PBX Integration board interprets this disconnect message as a loop current drop event. Not all PBXs support disconnect supervision. Utility functions included in the Unified API allow programmers to control the PBX Integration board. Your application can retrieve the PBX Integration channel and board type, obtain and set PBX Integration channel and board parameters, start and stop the D/42 driver, retrieve D/42 firmware/driver/library version numbers, and retrieve error information. By using the Unified API to determine the type of switch that the PBX Integration board is connected to, programmers can create an application that can provide specific control for each PBX. Specific control is 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 continue to do so, as the Unified API also provides access to lower-level function calls made available through each individual switch protocol. And for customers unwilling to shift from older PBX integration development models, the Unified API provides for backward compatibility, preserving their development investment PBX Integration Board Description The 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 18

29 3. PBX Integration Overview faxes, and control message notification. The PBX Integration board also provides positive disconnect supervision to immediately detect when a caller has hung up. When used with one of the supported PBXs, the PBX Integration board provides a flexible platform for developing integrated computer telephony applications. Dialogic developers can integrate current D/4x applications on the PBX Integration board with minimal software modifications and create more efficient applications for the PBX by offering value-added features. A PBX Integration board has either four or eight channels that can be connected directly to a supported PBX Features voice board with four or eight independent four-wire interfaces to a PBX, thereby reducing the 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 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. 19

30 PBX Integration board User s Guide Functional Description The PBX Integration board connects to several different PBXs, each of which has one or more compatible telephones with which it communicates. The PBX Integration board emulates 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 PBX Integration boards receive voice and control data from the connected PBX. The voice data is compressed by a DSP using an 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 PBX Integration board to a command processor where it is converted from its native format to D/41D 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). Address Bus Data Bus H.100 Bus PCI9052 Interface Control Lines 100 MHz Onyx DSP with 256K x 24 SRAM with 2 Wait States TDM Signals CT812 Time Slot Interchange PCI Bus Interface Glue Logic FPGA Front End To PBX Configuration Data Figure 1. PBX Integration board Functional Block Diagram Voice files stored on the host PC are read by the host driver and transferred to the 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. 20

31 3. PBX Integration Overview In addition to having all the standard features of a Dialogic D/41D board, the 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 PBX Integration board has an on-board microprocessor and a high-speed Digital Signal Processor (DSP) to provide voice and call processing. SpringWare voice processing firmware is downloaded from the host computer to SRAM and DSP memory when the PBX Integration board is started. SpringWare offers several features, including PerfectPitch Speed Control, PerfectLevel 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 SpringWare 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 Configurations The PBX Integration board connects to a line circuit board in a supported PBX to build sophisticated, computer telephony systems. The PBX Integration board installs in a minimum 90 MHz Pentium 5- or the equivalent Celeron -based platform with an available PCI bus slot for an 8-port system. The host system must provide a CPU of Pentium or Celeron class 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 PBX Integration board shares a large degree of common hardware and firmware architecture with other Dialogic products for maximum 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. 21

32 PBX Integration board User s Guide Software Support The development package includes all required libraries, drivers, and headers for simplified and seamless PBX integration. Diagnostics and demo programs provide additional tools and examples that allow developers to create complex multichannel voice applications. 22

33 4. PBX Systems 4.1. Lucent Definity PBXs The Lucent Definity product family includes the Definity 75/85 (4-wire) and the Definity G3 (2-wire) PBXs. The 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 PBX Integration board has either four or eight channels that are connected directly to a station module in a Lucent PBX. The PBX switch has many standard features that are supported by the PBX Integration board, such as: direct inward dialing (DID) hands free operation speed dialing hunt groups message waiting indication user programmable Feature Keys called/calling number identification call forwarding Lucent Switch Programming Requirements There are specific switch programming requirements for using a PBX Integration board with a Lucent Definity PBX. You must ensure that the PBX is configured properly so that the PBX Integration board functions correctly. Port Number Settings Each board in a Lucent PBX is assigned a port number. The number of ports vary according to the board type (2-wire or 4-wire). A 2-wire board has 16 ports, while the 4-wire boards has eight. Table 1 lists the structure used when configuring Lucent Definity PBX. For details about programming a Lucent PBX, refer to the appropriate Lucent manual. The following are examples of the switch settings: 23

34 PBX Integration board User s Guide Table 1. Lucent Definity Configuration Example Slot # Board Type Telephone Type Extension Numbers Port Settings 3 TN wire 8434D A A TN wire 8434D A A TN754B 4-wire 7434D A A TN754B 4-wire 7434D A A TN754B 4-wire 7434D A A TN754B 4-wire 7434D A A0808 The settings above should be tailored according to the your specific needs. Message Waiting Light Settings You must make certain settings from a Lucent management terminal to ensure that Message Waiting Indicator (MWI) features work correctly. 1. Login to switch from a management terminal. 2. Type command CH STAT <ext> where ext is the extension of a PBX Integration board port. On the Lucent phone sets, go to the Button Assignments page and set button 33 to lwc-store and button 34 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. 4. Repeat as necessary for other extensions Using the PBX Integration Board The PBX Integration board performs functions available to Lucent 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: 24

35 4. PBX Systems transfer calls set the message waiting indicator read the LED display read LED indicators read the called/calling number ID press keys. on/off Feature Buttons Conf Transfer Drop Hold Indicators Message Select Figure 2. Lucent 7434 Telephone 25

36 PBX Integration board User s Guide Display Display Buttons Feature Buttons Indicators Function Keys Figure 3. Lucent 8434 Telephone Programmable Feature Keys As illustrated in Figure 2 and Figure 3, there are 34 Programmable Feature Keys found on the Lucent 7434 and 8434 telephones. These keys are configured either during installation or by the user (using the telephone set or the PBX Integration board). There are two LED Indicators associated with each Feature Button. The PBX Integration board can also emulate four Lucent 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 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 26