TAPI Support (kb2241)

The information in this article applies to:

  • Microsoft Windows 7
  • Microsoft Windows Server 2008
  • Microsoft Windows Vista
  • Microsoft Windows Server 2003
  • Microsoft TAPI 2.x
  • SwyxIt! from version 3.20
  • Microsoft Windows XP Professional
  • Microsoft Windows XP Home Edition
  • Microsoft Windows NT 4.0 Workstation
  • Microsoft Windows NT 4.0 Server
  • Microsoft Windows Me
  • Microsoft Windows 98
  • Microsoft Windows 2000 Server
  • Microsoft Windows 2000 Professional

[ Summary | Information ]


Within the user defined setup of SwyxIt! the option TAPI Service Provider can be installed. If you already installed SwyxIt! without TAPI Service Provider, you can also add it later: Control panel, add or remove programs, SwyxIt!, change, modify.

This is a so called 1st Party TAPI (first party, client based).
A 3rd Party TAPI (third party, server based) is not supported by SwyxWare.

The SwyxIt! TAPI Service Provider (TSP) allows dialling from TAPI enabled applications like

  • CRM Systems
  • ERP Systems
  • others

The SwyxIt! TSP itself requires TAPI 2.x. If the TAPI client application is using a lower TAPI version (e.g. TAPI 1.4), then TAPI is capable of translating "down" to the application's version. If a TAPI 1.4 application is run, TAPI converts all TAPI 2.0 structures and messages into TAPI 1.4 equivalents, or as close as possible. If there is no close approximation in TAPI 1.4, then all TAPI 2.0-specific information will be lost.

On you will find a list of supported and tested applications. If you are not sure if your application is supported by Swyx or not feel free to contact our Presales Support.


1 Supported TAPI Functions

1.1 General Line Capabilities

API Version 0x00010003 to 0x00020000

  • Calls are dropped when closing the line
  • Answering a call puts the existing call on hold
  • Maximum Number of active calls: 99


1.1.1 Addressmodes

  • AddressID (Index)
  • Dialable Address (Digits)

1.1.2 Supported Bearermodes

  • Speech transmission
  • Voice transmission

1.1.3 Supported Line Features

  • Outgoing calls (MakeCall) is supported

1.2 Make Call Capabilities

  • Maximum Number of active calls: 99
  • Addressmode: AddressID (Index) Supported
  • Addressmode: Dialable Address (Digits) Supported
  • A destination address can be dialed on this address for making a call
  • Dial the destination number for the call (lineDial) is supported
  • Outgoing calls (lineMakeCall) is supported

1.3 Address Features

1.3.1 Call Features

  • Accept the call (lineAccept)
  • Answer the call (lineAnswer)
  • Perform a blind transfer on the call (lineBlindTransfer)
  • Complete the call (lineCompleteCall)
  • Complete the call transfer (lineCompleteTransfer)
  • Dial the destination number for the call (lineDial)
  • Drop the call (lineDrop)
  • Put the call on hold (lineHold)
  • Set call parameters (lineSetCallParams)
  • Set up a transfer (lineSetupTransfer)
  • Perform a swap hold operation (lineSwapHold)
  • Take the call off hold (lineUnhold)

1.3.2 Call Information Messages

  • One of the calledID-related fields of the call-information record

1.3.3 Caller ID Support

  • Caller ID Address
  • Caller ID name
  • Called ID Address
  • Called ID name

1.3.4 Call States Supported

  • Accepted
  • Connected
  • Dialing
  • Dialtone
  • Disconnected (remote)
  • Idle
  • Offering
  • Proceeding (proceeding through the switch after dialing)
  • Unknown

1.3.5 Number of Calls

  • Max number active calls : 99
  • Max number on hold calls: 99
  • Max number on hold pending calls: 99
  • Max number of calls in a conference: 0
  • Max number of calls in a conference (completed transfer): 0

1.4 Supported TSP functions

File version:

Exported Functions:

  • TSPI_providerConfig
    (dummy implementation, does nothing)
  • TSPI_providerEnumDevices
  • TSPI_providerInit
  • TSPI_providerInstall
  • TSPI_providerRemove
  • TSPI_providerShutdown
  • TSPI_lineAnswer
  • TSPI_lineBlindTransfer
  • TSPI_lineClose
  • TSPI_lineCloseCall
  • TSPI_lineCompleteTransfer
  • TSPI_lineConditionalMediaDetection
    (dummy implementation, does nothing)
  • TSPI_lineDial
  • TSPI_lineDrop
  • TSPI_lineGetAddressCaps
  • TSPI_lineGetAddressID
  • TSPI_lineGetAddressStatus
  • TSPI_lineGetCallAddressID
  • TSPI_lineGetCallInfo
  • TSPI_lineGetCallStatus
  • TSPI_lineGetDevCaps
  • TSPI_lineGetDevConfig
  • TSPI_lineGetID
  • TSPI_lineGetLineDevStatus
  • TSPI_lineGetNumAddressIDs
  • TSPI_lineHold
  • TSPI_lineMakeCall
  • TSPI_lineNegotiateTSPIVersion
  • TSPI_lineOpen
  • TSPI_lineSetAppSpecific
  • TSPI_lineSetDefaultMediaDetection
  • TSPI_lineSetDevConfig
    (dummy implementation, does nothing)
  • TSPI_lineSetStatusMessages
    (dummy implementation, does nothing)
  • TSPI_lineSetupTransfer
  • TSPI_lineSwapHold
  • TSPI_lineUnhold
  • TSPI_providerGenericDialogData
    (dummy implementation, does nothing)
  • TSPI_providerUIIdentify
  • TUISPI_providerConfig
    (dummy implementation, does nothing)
  • TUISPI_providerInstall
  • TUISPI_providerRemove
  • TUISPI_lineConfigDialog
    (dummy implementation, does nothing)

See also


Comment on this article

If we have any follow-up questions, where can we contact you?

E-Mail Address (optional)


This feedback form can't be used for support requests. Those requests must be directed to your Swyx reseller or distributor.