Overview of the Auerswald Telephony line device API set (TAPI)

 

This overview shows the support of TAPI 2.1 in Auerswald PBX systems. The functions listed are referenced in the Microsoft API specifications.

Important note: Auerswald historically supported two different TAPI devices: First Party TAPI via USB in telephones and legacy PBX systems and Third party TAPI via Ethernet with a TAPI server in the current PBX systems.

The following description lists the Third party TAPI support in the current PBX systems only!

Here is the matrix of supported PBX devices:

Auerswald PBX SystemFirmware VersionComment
COMmander 6000,
COMmander 6000R,
COMmander 6000RX
> V5.0A
(> V5.4B with COMfortel 3500)
8 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.
COMmander Business > V4.0A
(> V4.2A with COMfortel 3500)
4 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.
COMmander Basic.2 > V4.0A
(> V4.2A with COMfortel 3500)
4 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.
COMpact 5000,
COMpact 5000R
> V6.2A
(> V6.2A with COMfortel 3500)
4 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.
COMpact 4000 > V6.4D
COMfortel 1100, 1500, 2500,
2500 AB and 2500 VoIP are not supported.
4 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.
COMpact 5010, COMpact 5020 > V4.0A
(> V4.2A with COMfortel 3500)
4 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.
COMpact 3000 > V4.0A
(no TAPI support for COMfortel 3500)
4 TAPI lines included.
Additional TAPI lines may be purchased in the Auerswald Upgrade Center.

Behaviour of connected telephones: Auerswald system telephones of the following types are fully remote controlled by the Third party TAPI and simulate outbound calls in all functions and calls lists.

Auerswald System telephoneFirmware VersionComment
COMfortel 3600 IP >= 2.2G
COMfortel 3500 > 1.4
COMfortel 3200 > 1.4
COMfortel 2600 IP > 2.0
COMfortel 1400 IP > 2.0
COMfortel 2500 VoIP > 4.4A
COMfortel 2600 > 1.0
COMfortel 1600 > 1.0
COMfortel 1400 > 1.4
COMfortel 1200 > 1.4
COMfortel 2500 (AB) > 4.4A
COMfortel 1500 > 4.4A
COMfortel 1100 > 4.4A

All other Auerswald telephones, standard analog telephones or standard ISDN telephones will receive an inbound call first for any outbound TAPI call. Also the TAPI functionality may be limited to basic functions.

The usability of some TAPI functions may also be limited by the parameters transferred while calling the function. This may be observed and tested when developing a TAPI application with Auerswald PBX systems.

Table of Contents

 

The Basic Telephony line device API set.

Function GroupAPI CallDescriptionSupport in Auerswald PBX systems
Basic linehandling lineInitialize Initializes the Telephony API line abstraction for use by the invoking application. Yes
lineShutdown Shuts down the application's use of the Telephony API line. Yes
lineNegotiateAPIVersion Allows an application to negotiate an API version to use. Yes. Max.
V. 2.2
lineOpen Opens a specified line device for providing subsequent monitoring and/or control of the line. Yes. The line has to be enabled in the configuration interface of the PBX.
lineClose Closes a specified opened line device. Yes
lineDrop Disconnects a call, or abandons a call attempt in progress. Yes
lineDeallocateCall De-allocates the specified call handle. Yes
Line settings and status lineGetDevCaps Returns the capabilities of a given line device. Yes
lineGetDevConfig Returns the configuration of a media stream device. No
lineGetlineDevStatus Returns the current status of the specified open line device. Yes
lineSetDevConfig Sets the configuration of the specified media stream device. No
lineSetStatusMessages Specifies the status changes for which the application wants to be notified. Yes
lineGetStatusMessages Returns the application's current line and address status message settings. Yes
lineGetID Retrieves a device ID associated with the specified open line, address, or call. Yes
lineSetNumRings Indicates the number of rings after which inbound calls are to be answered. No
lineGetNumRings This function returns the minimum number of rings requested with lineSetNumRings. No
lineGetIcon Allows an application to retrieve an icon for display to the user. Yes
lineConfigDialog Causes the provider of the specified line device to display a dialog that allows the user to configure parameters related to the line device. No
Inbound and outbound calls lineMakeCall Makes an outbound call and returns a call handle for it. Yes. The outbound call is possible with the line number and group numbers valid for this line.
The line will be logged in to the group (outbound) for the duration of this call.
lineDial Dials (parts of one or more) dialable addresses. Yes
lineAnswer Answers an inbound call. Yes
Addresses lineGetAddressCaps Returns the telephony capabilities of an address. Yes
lineGetAddressStatus Returns the current status of a specified address. Yes
lineGetAddressID Retrieves the address ID of an address specified using an alternate format. Yes
lineTranslateAddress Translates between an address in canonical format and an address in dialable format. Yes
lineSetCurrentLocation Sets the location used as the context for address translation. Yes
lineSetTollList Manipulates the toll list. No
lineGetTranslateCaps Returns address translation capabilities. Yes
Miscellaneous features lineGetCallInfo Returns mostly constant information about a call. Yes
lineGetCallStatus Returns complete call status information for the specified call. Yes
lineSetAppSpecific Sets the application-specific field of a call's information structure. No
LineRegisterRequestRecipient Registers or de-registers the application as a request recipient for the specified request mode. No
lineGetRequest Gets the next request from the Telephony DLL. No
lineSetCallPrivilege Sets the application's privilege to the privilege specified. No
lineHandoff Hands off call ownership and/or changes
an application's privileges to a call.
No
lineGetNewCalls Returns call handles to calls on a specified line or address for which the application does not yet have handles. Untested
lineGetConfRelatedCalls Returns a list of call handles that are part of the same conference call as the call specified as a parameter. Untested

Table of Contents

The Supplemental Telephony API set for line devices.

Function GroupAPI CallDescriptionSupport in Auerswald PBX systems
Digit and tone handling lineMonitorDigits Enables or disables digit detection notification on a specified call. No
LineGatherDigits Performs the buffered gathering of digits on a call. No
LineMonitorTones Specifies which tones to detect on a specified call. No
LineGenerateDigits Generates inband digits on a call. Yes
LineGenerateTone Generates a given set of tones inband on a call. No
Advanced call handling lineAccept Accepts an offered call and starts alerting both caller (ring-back) and called party (ring). No
LineRedirect Redirects an offering call to another address. No
LineSecureCall Secures an existing call from interference by other events such as call-waiting beeps on data connections. No
LineCompleteCall Places a call completion request. No
LineUncompleteCall Cancels a call completion request. No
Call hold lineHold Places the specified call on hard hold. Yes
LineUnhold Retrieves a held call. Yes
Call transfer lineSetupTransfer Prepares a specified call for transfer to another address. Yes
LineCompleteTransfer Transfers a call that was set up for transfer to another call, or enters a three-way conference. Yes
LineBlindTransfer Transfers a call to another party. Yes
>LineSwapHold Swaps the active call with the call currently on consultation hold. Yes
Call conference lineSetupConference Prepares a given call for the addition of another party. Yes
LinePrepareAddToConference Prepares to add a party to an existing conference call by allocating a consultation call that can later be added to the conference call that is placed on conference hold. No
LineAddToConference Adds a consultation call to an existing conference call. No
LineRemoveFromConference Removes a party from a conference call. Yes
Call park linePark Parks a given call at another address. No
LineUnpark Retrieves a parked call. No
Call forwarding lineForward Sets or cancels call forwarding requests. Yes
Call pickup linePickup Picks up a call that is alerting at another number. Picks up a call alerting at another destination address and returns a call handle for the picked up call (linePickup can also be used for call waiting). Yes. PBX checks authorization.
Miscellaneous advanced features lineSendUserUserInfo Sends user-to-user information to the remote party on the specified call (ISDN only). No
LineSetTerminal Specifies the terminal device to which the specified line, address events, or call media stream events are routed. No
LineSetCallParams Requests a change in the call parameters of an existing call. No
LineMonitorMedia Enables or disables media mode notification on a specified call. No
LineSetMediaControl Sets up a call's media stream for media control. No
LineSetMediaMode Sets the media mode(s) of the specified call in its LINECALLINFO structure. No

Table of Contents