BusinessPhone TAPI Bridge 2.1 building bridges to TAPI Reference Manual Cover Page Graphic Place the graphic directly on the page, do not worry about putting it in the text flow. Select Graphics > Properties and adjust the following settings: Width: 21,6 cm (Important!) Height: 14,9 cm (May be smaller) Top: 7,5 cm (Important!) Left: -0,3 cm (Important!) This text should then be hidden.
Reference Manual BusinessPhone TAPI Bridge - Version 2.1 Reference Manual EN/LZTBS 102 212/RM R2D Copyright Aastra Technologies Limited, 2008. All rights reserved. This document contains proprietary information which is protected by copyright. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, or translated into another language, without prior written consent of Astra Technologies Limited. WARRANTY The information in this document is subject to change without notice. AASTRA MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Astra shall not be liable for errors contained herein nor for incidental or consequential damages in connection with the furnishing, performance or use of this material. BusinessPhone BusinessLink for Windows is a registered trademark of Aastra Technologies Limited. Microsoft, Windows, Office and Outlook are registered trademarks of Microsoft Corporation. Acrobat and Acrobat Reader are registered trademarks of Adobe Systems Inc., USA. All other brand names or product names may be trademarks or registered trademarks of their respective owners and are used here for editorial purposes, with no intention to infringe. 2 BusinessPhone TAPI Bridge - V 2.1 Reference Manual
Welcome to the BusinessPhone TAPI Bridge Welcome to the BusinessPhone TAPI Bridge Aastra is pleased to offer the BusinessPhone TAPI Bridge. BusinessPhone BusinessLink for Windows brings advanced Computer Telephony Integration (CTI) applications within easy reach of small and medium-sized organisations. BusinessLink for Windows integrates your Windows network server with your office phone system to create a powerful solution platform for CTI applications. TAPI Bridge now combines the two worlds of TSAPI and TAPI by simply converting the TSAPI protocol of BusinessPhone BusinessLink for Windows to the standard Microsoft TAPI (TAPI 2.1) protocol. By using TSAPI and TAPI solutions on the same desktop PC, your business will be stimulated, while you still have the full flexibility of a Windows network environment. CTI can give your business a real competitive edge by ensuring you and your customers to speak to the right person at the right time, always being equipped with the right information. The System Manager s Guide describes how to install and maintain Aastra s TAPI Bridge with step-by-step instructuions. The Reference Manual contains a brief list of all Functions supported by the TAPI Brigde. The Programmer s Guide includes sufficient information and details on specific services and events that are supported by the the TAPI Bridge to develop Application Programming Interfaces (APIs) -> only on CTI Developer s Kit. BusinessPhone TAPI Bridge - V 2.1 Reference Manual 3
Table of Contents Table of Contents Welcome to the BusinessPhone TAPI Bridge............................................. 3 Appendix A BusinessPhone Functions.................................................. 5 Supported Functions.................................................................. 5 Not Supported Functions............................................................... 5 Appendix B TAPI Functions........................................................... 6 Supported Functions (Line Device Controls)................................................. 6 Not Supported Functions............................................................... 7 Appendix C TAPI Messages........................................................... 8 Supported Messages (Line Device Messages)............................................... 9 LINE_CALLSTATE.................................................................. 9 Not Supported Messages............................................................. 11 4 BusinessPhone Tapi Bridge - V 2.1 Reference Manual
Appendix A BusinessPhone Functions Appendix A BusinessPhone Functions Supported Functions No Function Supported 1 answer call 2 callback (busy / idle) 3 camp on 4 conference 5 deflection 6 diversion 7 DTMF 8 hold 9 inquiry / transfer 10 intrusion 12 make call 13 multi line access 14 pickup 15 retrieve 16 show ANI Not Supported Functions No Function Supported 1 follow me NO 2 external diversion NO BusinessPhone TAPI Bridge V 2.1 Reference Manual 5
Appendix B TAPI Functions Appendix B TAPI Functions Supported Functions (Line Device Controls) Function lineaddtoconference lineanswer lineclose linecompletecall linecompletetransfer linedeallocatecall linedrop lineforward linegeneratedigits linegetaddresscaps linegetaddressstatus linegetcallinfo linegetcallstatus linegetdevcaps linegetid linehold linemakecall linenegotiateextversion lineopen linepickup lineredirect linesetuptransfer lineunhold Supported Note: The line device linedial is not supported in the actual TAPI Bridge software but linemakecall can be used instead. 6 BusinessPhone TAPI Bridge V 2.1 Reference Manual
Appendix B TAPI Functions Not Supported Functions Function linedevspecific linedial Supported NO NO Note: The line device linedial is not supported in the actual TAPI Bridge software but linemakecall can be used instead. BusinessPhone TAPI Bridge V 2.1 Reference Manual 7
Appendix C TAPI Messages Appendix C TAPI Messages Messages are used to notify the application of asynchronous events. All of these messages are sent to the application through the message notification mechanism that the application specified in lineinitializeex. The message always contains a handle to the relevant object (phone, line, or call), which the application can determine the type of from the message type. Certain messages are used to notify the application about a change in an object's status. These messages provide the object handle and give an indication of which status item has changed. The application can call the appropriate "get status" function of the object to obtain the object's full status. When an event occurs, messages can be sent to zero, one, or more applications. The target applications for a message are determined by a number of different factors including the meaning of the message, the application's privilege to the object, whether or not the application initiated the request for which the message is a direct result, and the message masking that has been set by the application. Note the following points about messages: Asynchronous reply messages are only sent to the application that originated the request and cannot be masked. Messages that signal the completion of digit or tone generation or the gathering of digits are only sent to the application that requested the digit or tone generation. Messages that indicate line or address state changes are sent to all applications that have opened the line, so long as the message has been enabled through linesetstatusmessages. Messages that indicate call state and call information changes are sent to all applications that have a handle to the call. Messages that signal a digit detection, tone detection, or media type detection are sent to the applications that requested monitoring of that event. The TAPI Bridge software has only one TAPI Message included which is necessary for supporting the BusinessPhone functions mentioned in the the table Supported Functions on page 5. The supported TAPI Message is from type Line Device Messages. 8 BusinessPhone TAPI Bridge V 2.1 Reference Manual
Appendix C TAPI Messages Supported Messages (Line Device Messages) Function LINE_CALLSTATE Supported LINE_CALLSTATE The TAPI LINE_CALLSTATE message is sent when the status of the specified call has changed. Typically, several such messages are received during the lifetime of a call. Applications are notified of new incoming calls with this message; the new call is in the offering state. The application can use linegetcallstatus to retrieve more detailed information about the current status of the call. LINE_CALLSTATE hdevice = (DWORD) hcall; dwcallbackinstance = (DWORD) hcallback; dwparam1 = (DWORD) CallState; dwparem2 = (DWORD) CallStateDetail; dwparam3 = (DWORD) CallPrivilege; dwparam1 can have following values: dwparam1 LINECALLSTATE_BUSY, LINECALLSTATE_CONNECTED, LINECALLSTATE_DIALING The call is receiving a busy tone. A busy tone indicates that the call cannot be completed either a circuit (trunk) or the remote party's station are in use. The call has been established and the connection is made. Information is able to flow over the call between the originating address and the destination address. The originator is dialing digits on the call. The dialed digits are collected by the switch. BusinessPhone TAPI Bridge V 2.1 Reference Manual 9
Appendix C TAPI Messages dwparam1 LINECALLSTATE_DIALTONE LINECALLSTATE_DISCONNECTED LINECALLSTATE_IDLE LINECALLSTATE_OFFERING LINECALLSTATE_ONHOLD LINECALLSTATE_RINGBACK The call is receiving a dial tone from the switch, which means that the switch is ready to receive a dialed number. The remote party has disconnected from the call. The call exists but has not been connected. No activity exists on the call, which means that no call is currently active. A call can never transition into the idle state. The call is being offered to the station, signaling the arrival of a new call. The offering state is not the same as causing a phone or computer to ring. In some environments, a call in the offering state does not ring the user until the switch instructs the line to ring. An example use might be where an incoming call appears on several station sets but only the primary address rings. The instruction to ring does not affect any call states. The call is on hold by the switch. This frees the physical line, which allows another call to use the line. The station to be called has been reached, and the destination's switch is generating a ring tone back to the originator. A ringback means that the destination address is being alerted to the call. Note: dwparam2 and dwparam3 are not supported in the actual version. 10 BusinessPhone TAPI Bridge V 2.1 Reference Manual
Appendix C TAPI Messages Not Supported Messages Not applicable. BusinessPhone TAPI Bridge V 2.1 Reference Manual 11
All rights reserved. Aastra Technologies Limited For questions regarding the product, please contact your Aastra certified Sales Partner. Also visit us on www.aastra.com Aastra Technologies Limited 2008 EN/LZTBS 102 212/RM R2D The information in this document may be changed without notice. This document is a part of FASBS 102 212/CD and FASBS 102 202/CT2