TAPI Application

Overview


The UCx TAPI Service Provider is a "driver" that can be installed on a Microsoft Windows PC which enables the Microsoft TAPI to communicate with an Asterisk Manager and initiate outbound calls and hang up calls using Microsoft Outlook, Microsoft Dialer or any TAPI compatible applications. This Service Provider also supports receiving inbound calls with basic caller information on incoming calls so that some TAPI aware applications can use this information to do screen-popup, displaying caller information on the screen.
The UCx TAPI Service provider in the current release supports:

  • Ability to make Outgoing calls, from Microsoft Outlook or any other TAPI aware applications.
  • Ability to receive incoming calls with call controls enabled (Answer, Hold, Unhold, Hang-up)
  • Ability to monitor call states (Connected, On Hold)
  • Ability to receive basic caller information on incoming calls so TAPI aware applications can do screen popup with the caller information.
  • UNISTIM Phone support

Please note that any TAPI aware applications (e.g. Microsoft Outlook or Microsoft Dialer) can be used to make outgoing calls. In order to receive incoming calls, any TAPI aware applications that offer incoming call controls can be used. The Microsoft Outlook does not have any built-in support for screen-popping and this functionality can be achieved with Windows programs such as IdentaPop Pro TAPI Outlook Screen Pops or Resource Software International Limited Visual Rapport desktop software. The TAPI Call Monitor can also be used for handling call controls on the incoming call scenario. The TAPI Call Monitor displays the incoming calls and upon selecting the call, the call control buttons gets enabled (e.g. Answer, Hold, Drop etc.).

Prerequisites

  1. The UCx TAPI driver is dependent on the Microsoft Visual C++ 2010 Redistributable package. If your computer does not have this package already installed, please follow this link to download and install the package: 
    http://www.microsoft.com/en-ca/download/details.aspx?id=14632
     
  2. You must have administrative privileges to perform the procedure of adding the Telephony Service Provider. See the following Microsoft article for details.
    http://technet.microsoft.com/en-us/library/cc781090(v=ws.10).aspx

Application Installer Download

To download the UCx TAPI Service Provider installer, perform the following steps:

  1. Open the UCx Web-based Configuration Utility
  2. From the Extras tab, select Downloads
  3. From the left side column, select UCx Desktop Applications (or E-MetroTel Applications on R4.0)
  4. Use the Download Link to download the installer file onto your computer. Select the installer that matches the target operating system where the installer is going to be installed, 32 or 64 bit.
  5. The application can be installed by double clicking on the installer file.

Installation



A sample of the 64 bit UCx TAPI Service provider installer windows is as shown below. Follow instructions from the setup wizard to complete the installation.

Configuration

After the installation wizard has completed successfully, the UCx TAPI Service Provider needs to be added manually to the Microsoft TAPI service provider list.

Add Service Provider to Microsoft TAPI list

Follow these steps to add the UCx TAPI Service Provider on a 64 bit OS:

  • Open the Control Panel and select the Phone and Modem component
  • Select the Advanced tab
  • On the Advanced tab, select the Add button
  • Upon successful install, UCx TAPI Service Provider should show up in the list of providers
  • Select UCx TAPI Service Provider from the list of Telephony Providers, and select the Add button.
  • Select UCx TAPI Service Provider in the list of installed providers, and click the Configure button. The screen shot below shows the configuration page.

UCX TAPI Service Provider Configuration

Fill in the required fields and click OK to save the configuration.

Field Value
Host IP Enter the IP address for the UCx
Port Leave the port as 5038
User Enter the user name the TSP will use to log into UCx
Password Enter the password for the user to log into UCx
Extension Enter the UCx extension (e.g. 1000) that is going to be managed from the TAPI
Caller ID Name This field is optional
Asterisk Recording Check this box if you want to use MixMonitor instead of Monitor application for your call recording
(For more information on MixMonitor, view this link: http://www.voip-info.org/wiki/view/MixMonitor)
UCx TAPI Logging
  • Enable Logging to File
Check this box to enable logging to file
  • Enable Trace0
Leave this box unchecked. Used only by E-MetroTel support for debugging purposes. Note that log file will fill up very quickly if checked.

 

UCx Server Configuration

The Asterisk Manager interface configuration is necessary as this is the interface where the UCx TAPI Service provider attempts to connect to the UCx server and make calls.

To create the Asterisk Manager interface, perform the following steps:

  1. Open the UCx Web-based Configuration Utility
  2. From the PBX tab, select PBX Configuration
  3. From the left side column, select Asterisk API
  4. Enter a descriptive name for the Manager name (e.g. tapi)
  5. Enter a password for the Manager secret (e.g. tapi)
  6. The default values for the Deny and Permit fields are "0.0.0.0/0.0.0.0" and "127.0.0.1/255.255.255.0", this effectively blocks all devices on the network except for applications running on the UCx itself.
    If you want to allow devices on your local subnet (e.g. 192.168.1.xxx) to use this account, then modify the Permit field to: ""127.0.0.1/255.255.255.0&192.168.1.0/255.255.255.0".

    Use the "&" character as a separator for multiple networks.
  7. Select both Read and Write check boxes for all the fields except for "dialplan".
  8. Press the Submit Changes button


TAPI Firewall Setup

The UCx comes with a built-in Firewall that is disabled by default. If the firewall is activated TAPI will not work correctly. A port and rule needs to be defined in the Firewall for TAPI. Refer to the Firewall page for more information.

Port 5038 must have a definition added for TAPI in the UCx Firewall. See Define Ports for more details on Firewall ports.

 

A rule must then be created for the TAPI port definition. See Firewall Rules for more details on Firewall rules.


Any changes to the Firewall must then be saved to take affect