Main

CTI Supported Devices 5.9

Ting-Hao Chen — 2013-04-09T15:31:51Z

CTI (TAPI/JTAPI) Supported Device Matrix

Last update 04/08/2013

Device/Phone Model	SCCP	SIP	Remarks
Analog Phone	XX		Limitations for this device described at: http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/jtapi_dev/4_1_3/developer/jtdevch1.html#wp1029269
Cisco 12 S	XX		End of Software Maintenance Release 2001
Cisco 12 SP	XX		End of Software Maintenance Release 2001
Cisco 30 SP+	XX		End of Software Maintenance Release 2001
Cisco 3905		XX	Not a CTI supported device
Cisco 3911	NA	NA	Not a CTI supported device
Cisco 6901	XX	XX
Cisco 6911	XX	XX
Cisco 6921	XX	XX
Cisco 6941	XX	XX
Cisco 6945	XX	XX
Cisco 6961	XX	XX
Cisco 7902	XX		End of Software Maintenance Release 2007
Cisco 7905	XX		End of Software Maintenance Release 2007
Cisco 7906	XX	XX
Cisco 7910	XX		End of Software Maintenance Release 2007
Cisco 7911	XX	XX
Cisco 7912	XX		End of Software Maintenance Release 2007
Cisco 7914 Sidecar	XX		End of Software Maintenance Release 2010
Cisco 7915 Sidecar	XX	XX
Cisco 7916 Sidecar	XX	XX
Cisco CKEM Sidecar	XX	XX	Not a CTI supported device
Cisco 7920	XX		End of Software Maintenance Release 2008
Cisco 7921	XX
Cisco 7925 & 7925-EX	XX
Cisco 7926	XX
Cisco 7931	XX	XX	CTI supported only if roll-over is disabled. Starting with 7.1 this device is supported when corresponding role is added to user
Cisco 7935	XX		End of Software Maintenance Release 2005
Cisco 7936	XX		End of Software Maintenance Release 2011
Cisco 7937	XX
Cisco 7940	XX		End of Software Maintenance Release 2011
Cisco 7941	XX	XX
Cisco 7941G-GE	XX	XX	End of Software Maintenance Release 2009
Cisco 7942	XX	XX
Cisco 7945	XX	XX
Cisco 7960	XX		End of Software Maintenance Release 2011
Cisco 7961	XX	XX
Cisco 7961G-GE	XX	XX	End of Software Maintenance Release 2009
Cisco 7962	XX	XX
Cisco 7965	XX	XX
Cisco 7970	XX	XX	End of Software Maintenance Release 2009
Cisco 7971	XX	XX	End of Software Maintenance Release 2009
Cisco 7975	XX	XX
Cisco 7985	XX		End of Software Maintenance Release 2011
Cisco 8831		XX
Cisco 8941	XX	XX
Cisco 8945	XX	XX
Cisco 8961		XX	phoneSetDisplay() interface is not supported
Cisco 9951		XX	phoneSetDisplay() interface is not supported
Cisco 9971		XX	phoneSetDisplay() interface is not supported
Cisco DX650		XX	phoneSetDisplay() interface is not supported
Cisco E20		XX	Not a CTI supported device
Cisco EX60		XX	Not a CTI supported device
Cisco EX90		XX	Not a CTI supported device
Cisco CTS 500		XX	Not a CTI supported device
Cisco CTS 500-32		XX	Not a CTI supported device
Cisco CTS (all other models)		XX	Not a CTI supported device
Cisco ATA 186	XX		Limitations for this device described at: http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/jtapi_dev/4_1_3/developer/jtdevch1.html#wp1029269
Cisco ATA 187	NA	NA	Not a CTI supported device
Cisco ATA 188	NA	NA	Not a CTI supported device
Cisco Cius (Wifi & 4G)		XX	Product Discontinued
Cisco IP Communicator	XX	XX
Cisco Jabber for Windows - Softphone Mode		XX	Requires Jabber for Windows 9.0 or later
Cisco Jabber for Windows - Extend/Connect Mode	NA	NA	Requires CUCM 9.1(1a) and Jabber for Windows 9.1(2) or later
Cisco Jabber for Windows - Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco Jabber for Mac - Softphone Mode		XX	Requires CUCM 8.6(1)
Cisco Jabber for Mac - Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco Jabber for iPad	NA	NA	Not a CTI supported device
Cisco Jabber for iPhone	NA	NA	Not a CTI supported device
Cisco Jabber for Android	NA	NA	Not a CTI supported device
Cisco Unified Personal Communicator- Softphone Mode		XX	CTI support added in CUPC release 8.5(1)
Cisco Unified Personal Communicator- Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco Unified Communications Integration for Microsoft Office Communicator/Lync - Softphone Mode	NA	NA	Not a CTI supported device
Cisco Unified Communications Integration for Microsoft Office Communicator/Lync - Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco Unified Communications for RTX (CUCRTX) - Softphone Mode	NA	NA	Not a CTI supported device
Cisco Unified Communications for RTX (CUCRTX) - Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco Web Communicator for Wx Social - Softphone Mode	NA	NA	Not a CTI supported device
Cisco Web Communicator for Wx Social - Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco Unified Communications Integration for WebEx Connect - Softphone Mode	NA	NA	Not a CTI supported device
Cisco Unified Communications Integration for WebEx Connect - Remote Desktop Control Mode	NA	NA	Refer to the device model under remote control to determine CTI support. Click-to-Answer requires device speakerphone support.
Cisco VGC Phone	XX
VG224	NA	NA	Not a CTI supported device
VG248	XX		Limitations for this device described at: http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/jtapi_dev/4_1_3/developer/jtdevch1.html#wp1029269
CTI Port	NA	NA	CTI Supported virtual device that doesn't use SCCP or SIP
CTI Remote Device (Extend/Connect)	NA	NA	CTI Supported virtual device that doesn't use SCCP or SIP
CTI Route Point	NA	NA	CTI Supported virtual device that doesn't use SCCP or SIP
ISDN BRI Phone	NA	NA	Not a CTI supported device
IMS Client	NA	NA	Not a CTI supported device
Mobile Communicator	NA	NA	Not a CTI supported device

Special Firmware Download Instructions:

1. Navigate to http://tools.cisco.com/support/downloads/go/Redirect.x?mdfid=278875240

2. Select IP Telephony, then IP Phones

3. Navigate to the appropriate IP Phone Model Folder as determined by the device model.

4. After downloading the firmware, please refer to the firmware upload instructions found in the Unified CM Administration guide.

Compatibility of Cisco IP Phones & Clients

Phone models that are End of Software Maintenance will continue to be supported on the latest Unified Communications Manager releases. However, they will not take advantage of any new Unified Communications Manager or firmware features associated with that release.

For more information on End of Sale phone models, reference the model's End of Sale announcement for information on level of firmware and hardware support.

TAPI Case Opening Steps 8.0

Adrienne Moherek — 2013-02-20T21:05:25Z

For development issues and questions that cannot be addressed through these services, CDN also offers members the ability to open support cases with our development engineering team utilizing Cisco’s case tracking application.

For CDN Community Members: This service is available as an annual fee-based subscription. Pricing: This fee varies by theater.

For CDN Technology Partners: This service is included in your CDN Technology Partner memberships.

Learn more about purchasing a developer support subscription

To help resolve your case quickly, please provide the following information while opening a developer support case for a TAPI issue.

General description of the problem
Is the problem reproducible or intermittent?
Device Names, Directory Names (DN's)
Observed vs. expected API behavior
Version Number of CUCM
Version Number of TAPI
Version of Windows
Dr.Watson Logs (In case of a TSP crash)
TAPI Logs (Gathering detailed level TAPI Traces )
Cisco CTI/Call Manager Traces( Gathering CTI/CM (SDI/SDL) Traces )
Time Stamp of the Issue

Gathering detailed level TAPI traces

Below are the steps to gather detailed TAPI traces

Step 1:
Login to the server that is running your application. Choose Start > Settings > Control Panel and select Phone and Modem Options.
Step 2:
Click Advanced tab and select the CiscoTSP 0xx and click Configure button.
Step 3:

Click the Trace tab. Select Trace On check box and
1. Check the TSP Trace to trace the TSP internal messages. Select Detailed to log internal messages for debugging purposes.
2. Check the CTI Trace to trace the messages sent between CTI and TSP.
3. Check the TSPI Trace to trace the requests and events that are sent between TSP and TAPI.
Step 4:
Set up a Directory that is the path for the trace log. For example, c:\Temp No. of Files: Setting this to a value greater than or equal to 1 enables rolling log files. For example, a value of 10 will cause up to 10 log files to be used in a cyclic fashion. Max lines/file: specifies the maximum number of trace statements that will be written to each log file. For example, a value of 1000 will cause up to 1000 trace statements to be written to each log file.

After setting these options, you will need to restart the machine or follow these steps for the settings to take effect.
1. Stop all TAPI applications.
2. Stop the “Telephony” service (However, this is dependent on stopping the “Remote Access Connection Manager” service if it is running and Microsoft does not allow this service to be stopped in most Windows OS).
3. Restart the TAPI application (notice that you don’t need to start the “Telephony” service since starting the 1st TAPI application restarts this service) .
Because of step #2, it would be easier to reboot the machine.

Gathering CTI/CM (SDI/SDL) Traces

Please Enable the following on Call Manager Side to collect CTI-SDI traces.
1. From CCM Serviceabitliy page, go to CM Services/Cisco CTIManager(Active)
2. Check the trace output Settings, if there is a large amount of traffic, you may need to increase the number and/or size of the files to ensure they are nor overwritten too quickly. For this purpose leaving this column default is fine.
3. Select Select SDL Configurations in related links and do similar configurations to collect these Traces.
4. Select SDL Configurations in related links and do the similar configurations to collect the CTI-SDL traces.
Please Enable the following on Call Manager Side to collect CCM-SDI traces.
1. From CCM Serviciability page, go to CM Services/CiscoCallManager(Active)
2. Check the trace output Settings, if there is a large amount of traffic, you may need to increase the number and/or size of the files to ensure they are nor overwritten too quickly. For this purpose leaving this column default is fine.
Run the test (The application you want to test or which is creating the issue).
If you don't have the RTMT tool, Download it from the Call Manager Admin Page -> Application -> Plugin.
Now, using the RTMT Tool, you can collect the CCM/CTI (SDI/SDL)traces, for that connect to CM and select Trace&Log Central and/or double click on collect files. Check all the servers for Cisco CTIManager & Cisco CallManager
On Collect File option screen, Select an Absolute range approximately 30 minutes before and after your test run. To zip the files is a convenient option. Please e-mail or attach these files to your case using the on line TAC case tool.

Frequently Asked Questions 1.4

Varun Shahdadpuri — 2012-10-15T08:24:28Z

<> == Message Board == Link to Forum Discussion ==> [[http://developer.cisco.com/web/tapi/forums|Forums]] == Correlation between JTAPI and TAPI CallID == **JTAPI CallID calculation formula** JTAPI Calculates CallID using the below logic:- JTAPI Call Id = First 8 bits for CallManagerID and 24 bits for CallID -> ((callManagerID & 0x00ff) << 24) | (globalCallID & 0x00ffffff) For example, if the CallManagerID= 1 (0x01) and the CallID=3884 (0x00000F2C), then using the above formula JTAPI CallID becomes 0x01000F2C which is 16781100 in decimal. **TAPI CallID calculation formula** TAPI Calculates CallID using the below logic:- TAPI CALLID = First 10 bits for CallManagerID and 22 bits for CallID -> ((callManagerID & 0x03ff) << 22) | (globalCallID & 0x003fffff) For example, if the CallManagerID= 1 (0x01) and the CallID= 0x00000F2C, then using the above formula TAPI CallID becomes 0x00400F2C. From this we can find, TAPI CallID is different from that of JTAPI CallID. More info:- JTAPI exposes two interfaces that expose call id. However the integer value of call id exposed by JTAPI already is deprecated in 8.0. So from 8.0 onwards, JTAPI application should use non-integer interface to obtain call id, and TAPI app should use new info in LineCallInfo::DevSpecific which exposes both CallManagerID and CallID. However the old interface is deprecated but not removed yet. If the developers want, they still can use the above formulas to correlate call ids for pre-8.0 CUCM releases. The deprecation only applies to 8.0 and onwards.

UC Support for Microsoft Windows 7 1.7

Matthew J Denapoli — 2012-09-28T21:16:03Z

For details on Cisco Unified Communications Support for Microsoft Windows 7 please refer:

http://www.cisco.com/en/US/prod/collateral/voicesw/ps6789/ps7046/ps7282/product_bulletin_c25-563280.html

TAPI Troubleshooting 1.8

Matthew J Denapoli — 2012-09-28T21:15:57Z

== Please refer to the following child pages ==

How to obtain Event Log Traces 1.8

Matthew J Denapoli — 2012-09-28T21:15:22Z

The Event log is used by Windows applications to report errors and warnings. The Miu reports serious failures to the Event log, for example, "Component Miu: thread <XXX> had a failure on port <YYY> in AvWav."

To Obtain an Event Log Trace

Step 1 On the Windows Start menu, click Programs > Administrative Tools > Event Viewer.

Step 2 In the Tree pane, click Application Log.

Step 3 Look for failure messages in the Application log. These can include errors from the Miu or AvWav, as well as errors from other Cisco Unity components or Exchange errors.

Step 4 If failure messages are present in the Application log, in the Tree pane, click Application Log. Then, on the Action menu, click Save Log File As.

Step 5 In the Save as Type field, click CSV, then click Save. Do not save the raw Event log data in a *.evt file.

How to gather Dr.Watson Logs 2.4

Matthew J Denapoli — 2012-09-28T21:14:48Z

Dr. Watson is a program invoked by Windows 2000 when a serious problem occurs that is not handled by Cisco Unity. When Dr. Watson is invoked, a dialog box appears containing an error message, for example, "Dr. Watson encountering an error in the AvCsMgr.exe process." Dr. Watson errors may occur in other processes such as Tapisrv.exe, or Dlgc_srv.exe.

To Obtain a Dr. Watson Log

Step 1 When a Dr. Watson error occurs, make a copy of the file Winnt\Drwtsn32.log.

Step 2 Before you attempt to reproduce the problem, from a command prompt,enter drwtsn32 and press Enter.

Step 3 In the Number of Instructions field, enter 50.

Step 4 In the Number of Errors to Save field, enter the number of errors you want to record. The default is 10.

Step 5 Under Options, confirm that the Dump All Thread Contexts, Append to Existing Log File, Visual Notification, and Create Crash Dump File check boxes are checked.

Step 6 Click OK to close the dialog box.

Step 7 Reproduce the problem.

Step 8 Make a copy of the file Winnt\Drwtsn32.log.

Cisco Unified TAPI Operations-by-Release Matrix 2.9

Matthew J Denapoli — 2012-09-28T21:13:57Z

Cisco Unified TAPI Operations-by-Release Matrix

Supported TAPI feature matrix

UCR - Under Consideration or Review
: supported, : not supported, : modified

Interface Changes at a Glance/History Chart

TSP Features	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0	UCR
CTI Manager and Support for fault tolerance
Support for Cisco CallManager Extension Mobility
Support for Multiple CiscoTSP
(Redirect Support for) Blind Transfer
Support for swap hold and setup transfer with the lineDevSpecific() function
Support for lineForward()
Support to Set the Original Called Party upon Redirect with the lineDevSpecific function
Line In-Service or Out-of-Service
Support for multiple languages in the CiscoTSP installation program and in the CiscoTSP configuration dialogs
User Deletion from Directory
Opening Two Lines on One CTI Port Device
Support for linePark and lineUnpark
Support for monitoring Call Park Directory Numbers using lineOpen
Call Reason Enhancements
Device Data Passthrough
CiscoTSP Auto Update
Multiple Calls per Line Appearance
Shared Line Appearance
Select Calls
Transfer Changes
Direct Transfer
Conference Changes
Join
Privacy Release
Barge and cBarge
Dynamic Port Registration
Media Termination at Route Points
QoS support
Support for Presentation Indication
Windows 2003 Support
Unicode Support
SRTP support
Partition Support
SuperProvider Functionality
Security (TLS) support
FAC/CMC Support
CTI Port Third Party Monitoring
Alternate Script Support
SIP Features Refer/Replaces
SIP URI
SIP phone support
Change Notification of SupetProvider and CallParkDN Monitoring flags
3XX
Intercom Support
Secure Conferencing Support
Monitoring & Recording
Arabic and Hebrew Language Support
Do-Not-Disturb Support
Conference Enhancement
Join AcrossLine (SCCP)
Join AcrossLine (SIP)
Locale Infrastructure Enhancement
Do-Not-Disturb Rejection
Call Party Normalization
Click-To-Conference
IPv6 Support on Linux
Windows Vista Support
Enhaced MWI
Direct Transfer Across Lines
Support for > 100DNs
Swap/Cancel support on RoundTable phone (8900 and 9900 device families)
Drop Any Party
Park Reversion
Conditional Reset
Logical Partition
Assisted DPark
RT_Lite (6900 device family) Phone Support
Device State Server
Exposing Busy Trigger / Line Number / Voice Mail Pilot / Line Label / New call outbound rollover/ Consult call rollover/JAL/DTAL flag and IP address (IPv4 & IPv6) of the device
Hunt List Support
External Call Control (ECC) Support
Call Control Discover (CCD) Support
Entension Mobility Cross Cluster (EMCC) Support
Call Pickup Support
End-To-End Call Tracing
Secure Monitoring Support
Unified B2B link support
iSAC Codec Support
New TSP Client with remote silent installation
New Cisco TSP Wave Driver ( Cisco RTP Libbrary)
Agent Greeting
Agent Zip Tone
Early Offer
Extension Mobility Memory Optimization
Other-Device State Notification
Energy Wise
Whisper Coaching
FIPS compliant (UCR 2008 Support)
Password Expiry and Account Lockout (UCR 2008 Support)
Support for Codian SIP MCU
TSP Native 64Bit support (*1)
TSP Native 64Bit SRTP support
Support for multiples calls per line on RTLite Phones
Single Sign On
URI Dialing
Recording Enhancements (Device based Recording)
Hunt Pilot Connected Number
Native Queuing
CTI Remote Device (Cisco Extend & Connect)
CIUS session Persistency

*1 - TSP Native 64Bit support is from 8.5.1 SU1 onwards.

TAPI Line Functions

TAPI Line Functions	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0
LineAddToConference
LineCompleteTransfer
LineDevSpecific
LineForward
LinePark
LineUnpark
LineRedirect
LineBlindTransfer
LineDevSpecificFeature
LineRemoveFromConference

TAPI Line Messages

TAPI Line Messages	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0
LINE_ADDRESSSTATE
LINE_CALLINFO
LINE_CALLSTATE
LINE_REMOVE
LINE_DEVSPECIFIC
LINE_DEVSPECIFICFEATURE
LINE_CALLDEVSPECIFIC

TAPI Line Structures

TAPI Line Structures	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0
LINEADDRESSCAPS
LINECALLSTATUS
LINEFORWARD
LINEFORWARDLIST
LINEDEVCAPS
LINEDEVSTATUS
LINECALLINFO

TAPI Phone Functions

TAPI Phone Functions	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0
PhoneDevSpecific
PhoneGetStatus

TAPI Phone Messages

TAPI Phone Messages	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	5.2	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0
PHONE_REMOVE
PHONE_DEVSPECIFIC

TAPI Phone Structures

TAPI Phone Structures	3.1	3.2	3.3	4.0	4.1	4.2	4.3	5.0	5.1	5.2	6.0	6.1	7.0	7.1	7.1.3	8.0	8.5	8.6	9.0
PHONECAPS
PHONESTATUS

Wiki Home 16.5

Matthew J Denapoli — 2012-09-28T21:13:28Z

=== This is the home page of the Cisco TAPI Wiki space ===

Helpful Links 1.0

David Staudt — 2011-09-20T00:01:50Z

* **libSRTP** http://srtp.sourceforge.net/srtp.html Description: An open-source implementation of the Secure Real-time Transport Protocol (SRTP) originally authored by Cisco Systems, Inc. It is available under a BSD-style license.