Unified Communications Manager (CallManager)

Cisco Unified Communications Manager (CallManager), Unified Communications Manager Version 12.5 User guide

  • Hello! I am an AI chatbot trained to assist you with the Cisco Unified Communications Manager (CallManager) User guide. I’ve already reviewed the document and can help you find the information you need or explain it in simple terms. Just ask your questions, and providing more details will help me assist you more effectively!
Cisco Unified JTAPI Developers Guide for Cisco Unified
Communications Manager Release 12.5(1)
First Published: 2019-01-23
Last Modified: 2021-03-05
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of
the UNIX operating system. All rights reserved. Copyright ©1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.
Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
https://www.cisco.com/c/en/us/about/legal/trademarks.html. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a
partnership relationship between Cisco and any other company. (1721R)
©2021 Cisco Systems, Inc. All rights reserved.
CONTENTS
Overview 1
CHAPTER 1
Cisco Unified Communications Manager Interfaces 1
Provisioning Interfaces 2
Administrative XML 2
Cisco Extension Mobility 2
Device Monitoring and Call Control Interfaces 2
Cisco TAPI and Media Driver 2
Cisco JTAPI 3
Cisco Web Dialer 3
Serviceability Interfaces 3
Serviceability XML 3
SNMP/MIBs 4
Routing Rules Interface 4
Cisco Connection Interface 4
JTAPI Overview 5
Cisco Unified JTAPI and Contact Centers 5
Cisco Unified JTAPI and Enterprises 5
Cisco Unified JTAPI Applications 6
Jtprefs Application 7
Cisco Unified JTAPI Concepts 7
CiscoObjectContainer Interface 8
JtapiPeer and Provider 8
Initialization 9
Shutdown 9
Provider.getTerminals() 9
Provider.getAddresses() 9
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
iii
Changes to the User Control List in the Directory 9
Address and Terminal Relationships 10
Unobserved Addresses and Terminals 11
Connections 11
Terminal Connections 11
Terminal and Address Restrictions 11
CiscoConnectionID 14
Threaded Callbacks 14
CiscoSynchronousObserver Interface 15
Querying Dynamic Objects 15
callChangeEvent() 15
CiscoConsultCall 15
CiscoTransferStartEv 16
Alarm Services 16
Software Requirements 16
Development Guidelines 16
New and Changed Information 19
CHAPTER 2
Cisco Unified Communications Manager Release 12.5(1) 19
Cisco Unified Communications Manager, Release 11.5(1) 20
Cisco Unified Communications Manager, Release 11.0(1) 20
Cisco Unified Communications Manager Release 10.5(2) 20
Cisco Unified Communications Manager Release 10.0(1) 20
Cisco Unified Communications Manager Release 9.0(1) 21
Cisco Unified Communications Manager Release 8.6(1) 21
Cisco Unified Communications Manager Release 8.5(1) 21
Cisco Unified Communications Manager Release 8.0(1) 22
Cisco Unified Communications Manager Release 7.1(3) 22
Cisco Unified Communications Manager Release 7.1(2) 22
Cisco Unified Communications Manager Release 7.0(1) 23
Cisco Unified Communications Manager Release 6.1 24
Cisco Unified Communications Manager Release 6.0 25
Cisco Unified Communications Manager Release 5.1 25
Cisco Unified Communications Manager Release 5.0 26
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
iv
Contents
Features Supported by Cisco Unified JTAPI 27
CHAPTER 3
Account Lockout 31
Agent Greeting 31
AES 256 Algorithm IDs 32
Alternate Script Support 33
API for Exposing Built-In-Bridge Status 33
Arabic and Hebrew Language Support 34
Auto Updater for Linux 34
AutoAccept Support for CTI Ports and Route Points 34
Autoupdate of API 36
Barge and Privacy Event Notification 38
Call Control Discovery 39
Call Forward 39
Call Forward Override 39
Call Park 40
Call Pickup 40
Call Recording for SIP or TLS Authenticated Calls 41
Call Select Status 41
Calling Party Display Name 41
Calling Party IP Address 42
Calling Party IP Address 42
Calling Party Normalization 43
CallFwdAll Key Press Notification 44
CallSelect and UnSelect Event Notification 44
Certificate Download API Enhancement 45
Changes in DeviceType Name Handling 45
Cisco MediaTerminal 46
Provisioning 46
Registration 46
Adding Observers 48
Accepting Calls 48
Cisco Unified Communications Manager Media Endpoint Model 48
Payload and Parameter Negotiation 49
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
v
Contents
Initialization 49
Payload Selection 49
Receive Channel Allocation 50
Starting Transmission and Reception 50
Stopping Transmission and Reception 50
Cisco Unified Communications Manager Server Failure 50
Cisco Unified IP 7931G Phone Interaction 51
Cisco Unified JTAPI Install Internationalization 52
Cisco VG248 and ATA 186 Analog Phone Gateways 52
CiscoJtapiExceptions 53
Errors 53
CiscoProvAuthenticationInfoEv 54
CiscoRTPHandle Interface on Cisco RTP Events 54
Cisco Terminal Filter and ButtonPressedEvents 55
CiscoTermRegistrationfailed Event 56
Errors 56
Cius Persistency 57
Clear Calls 58
Click to Conference 58
Cluster Abstraction 59
Command Line Invocation 60
Component Updater 60
Conference 60
Cisco Extensions 61
Conference Scenarios 61
Conference Events 62
Transfer and Conference Enhancement 63
Conference and Join 63
Conference Chaining 65
Consult Without Media 66
CTI Ports 66
CTI RoutePoints 66
CTI Remote Device for JTAPI 67
Play Announcement 67
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
vi
Contents
Verify Remote Destination Support 68
NuRD (Number Matching for Remote Destination) Support 69
Mobility Interaction Support 70
CTI RD Call Forward 70
CTI Video Support 71
Default CTI IP Addressing for Devices 72
DeleteCall 73
Device Recovery 73
Device Recovery for Phones 73
Device State Server 73
Direct Transfer Across Lines 75
Usage Guidelines 75
Event Flow Comparison and Sample Code 75
Directed Call Park 80
Directory Change Notification 81
Do Not Disturb 81
Do Not Disturb-Reject 82
Drop Any Party 83
Dynamic CTI Port Registration 84
E911 Teleworker 86
Enable or Disable Ringer 86
Encryption Enhancement 87
End to End Call Tracing 87
EnergyWise Deep Sleep Mode 88
Extension Mobility Cross Cluster 90
Extension Mobility Username Login 91
External Call Control 91
End to End Session ID for Calls 92
FIPS Compliance 93
Forced Authorization and Client Matter Codes 94
Supported Interfaces 95
Call.Connect() and Call.Consult() 95
Call.transfer(String) and Connection.redirect() 96
RouteSession.selectRoute() 96
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
vii
Contents
Forwarding on No Bandwidth and Unregistered DN 97
GetCallID in RTP Events 97
GetCallInfo 97
GetGlobalCallID 98
Hairpin Support 98
Half-Duplex Media Support 99
Hold Reversion 100
Hunt List 100
Hunt List Connected Number 101
Hunt Log Status 102
Intercom 103
Intercom Support for Extension Mobility 105
IPv6 Support 105
iSac Codec 106
Java Socket Connect Timeout 107
Join Across Lines 107
Join Across Lines (Only SCCP) 108
Join Across Lines or Connected Conference Across Lines 108
Usage Guidelines 108
Event Flow Comparison and Sample Code 109
Join Across Lines with Conference Enhancements (SCCP and SIP) 113
JRE 1.2 and JRE 1.3 Support Removal 114
JTAPI Version Information 115
Locale Infrastructure Development 115
Logical Partitioning 116
Media Termination at Route Point 116
Media Termination Extensions 118
Message Waiting Indicator Enhancement 119
Modifying Calling Number 120
Multi-fork Recording using CUBE Media Proxy Server 121
Multilevel Precedence and Preemption Support 122
Multiple Calls Per DN 122
Native Queuing 122
Network Alerting 124
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
viii
Contents
Network Events 124
New Error Code in CiscoTermRegistrationFailedEv 125
Noncontroller Adding of Parties to Conferences 125
Park DN Monitor 126
Park Monitoring and Assisted DPark Support 126
Park Reminder 128
Park Retrieval 128
Partition Support 128
Password Expiry 131
Persistent Connection 132
Play Zip Tone 134
Presentation Indicator for Calls 134
Privacy On Hold 136
Progress State Converted to Disconnect State 136
Q.Signaling (QSIG) Path Replacement 136
QoS Support 137
QoS Setup on Windows 2000 138
QoS Setup on Windows XP Server 2003 138
Quiet Clear 138
Receiving and Responding to Media Flow Events 139
Inbound Call Media Flow Event Diagram 139
Cisco Unified Communications Solutions RTP Implementation 140
Recording 141
Redirect 144
Redirect Set Original Called ID 145
Redirect to Device 145
Redundancy 146
Redundancy in CTI Managers 147
Invoking CTIManager Redundancy 147
CTIManager Failure 148
Heartbeats 148
Ringback on SIP 183 for Transferred Calls 149
Routing 149
Cisco Route Session Implementation 150
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
ix
Contents
Select Route Timer 150
Forwarding Timer 151
Route Session Extension 151
Caller Options Summary 151
Fault Tolerance When Using Route Points 151
Secure Conferencing 152
Secure Real-Time Protocol Key Material 152
Secured Monitoring and Recording 158
SelectRoute Interface Enhancement 159
selectRoute() with Calling Search Space and Feature Priority 160
Set MessageWaiting 161
Shared Line Support 161
Silent Monitoring 164
Single Sign-On 166
Single Step Transfer 168
SIP 3XX Redirection 168
SIP Phone Support 169
SIP REFER or REPLACE 172
SIP Trunk Early Offer 173
Star (*) 50 Update 176
Super Provider (Disable Device Validation) 176
Superprovider and Change Notification 177
Support for Cisco Unified IP Phone 6901 179
Support for Cisco Unified IP Phone 6900 Series 180
Support for 100+ Directory Numbers 181
Support for VMware 182
Swap or Cancel and Transfer or Conference Behavior 183
Terminal and Address Capability Settings 184
Terminal and Address Restrictions 185
SHA-512 Support for Digital Signatures 189
Transfer 189
CiscoTransferStartEv 189
CiscoTransferEndEv 190
Transfer Scenarios 190
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
x
Contents
Transfer and Conference Extensions 192
Transfer and DirectTransfer 192
Translation Pattern Support 193
Transport Layer Security (TLS) 194
Unicode Support 200
Unrestricted Unified CM 202
URI Dialing 203
Version Format Change 204
Verification Involving PSTN Reachability 204
Video Capabilities and Multi-Media Information 204
Exposing Multimedia Capability on CiscoTerminal 204
Exposing Changes in Multimedia Capability Via a New Provider Event 205
Exposing Multimedia Capability on a CiscoCall 205
Exposing Multimedia Streams Information on CiscoTerminal 205
Supported Features (Within the Same Cluster) 206
Supported Features (Across Clusters) 207
Limitations 207
Video On Hold Support 208
Voice MailBox Support 208
XSI Object Pass Through 209
CiscoTerminal Method 209
Authentication and Mechanism 210
Cisco Unified JTAPI Installation 211
CHAPTER 4
Overview 211
Required Software 212
Supported Platforms 212
Installing the Cisco Unified JTAPI Software 212
Installation Procedures 212
Linux Platforms 218
Verifying Linux Installation 220
Windows Platforms 220
Verifying Windows Installation 222
Linux and Windows Installation 222
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xi
Contents
Using Cisco Unified CM JTAPI 223
Program Group and Program Elements 223
Cisco Unified JTAPI Configuration Settings 223
JTAPI Tracing Tab 224
Log Destination Tab 226
Cisco Unified CM Tab 228
Advanced Tab 229
Security Tab 232
Language Tab 234
Managing the Cisco Unified CM JTAPI 236
Reinstalling, Upgrading or Downgrading the Cisco JTAPI 236
Uninstalling the Cisco JTAPI 236
Administering User Information for JTAPI Applications 237
Fields in the jtapi.ini File 237
Sample jtapi.ini File with Default Values 243
Hierarchy for All Cisco Unified JTAPI Packages 245
CHAPTER 5
Class Hierarchy 245
Interface Hierarchy 246
Cisco Unified JTAPI Extensions 255
CHAPTER 6
Class Hierarchy 259
CiscoAddressCallInfo 259
Declaration 259
Constructors 260
Fields 260
Methods 260
Inherited Methods 260
Related Documentation 260
CiscoG711MediaCapability 261
Declaration 261
Constructors 261
Fields 261
Inherited Fields 262
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xii
Contents
Methods 262
Inherited Methods 262
Related Documentation 262
CiscoG723MediaCapability 262
Declaration 262
Constructors 263
Fields 263
Inherited Fields 263
Methods 263
Inherited Methods 264
Related Documentation 264
CiscoG729MediaCapability 264
Declaration 264
Constructors 264
Fields 265
Inherited Fields 265
Methods 265
Inherited Methods 265
Related Documentation 265
CiscoGSMMediaCapability 265
Declaration 266
Constructors 266
Fields 266
Inherited Fields 266
Methods 266
Inherited Methods 267
Related Documentation 267
CiscoJtapiVersion 267
Declaration 267
Constructors 267
Fields 267
Methods 268
Inherited Methods 268
Related Documentation 268
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xiii
Contents
CiscoMediaCapability 268
Declaration 269
Subclasses 269
Constructors 269
Fields 269
Methods 270
Inherited Methods 270
Related Documentation 270
CiscoMultiMediaCapabilityInfo 270
Declaration 270
Fields 271
Methods 271
CiscoRegistrationException 271
Declaration 272
Implemented Interfaces 272
Constructors 272
Methods 272
Inherited Methods 272
Related Documentation 272
CiscoRTPParams 273
Declaration 273
Constructors 273
Fields 273
Methods 273
Inherited Methods 274
Related Documentation 274
CiscoUnregistrationException 274
Declaration 274
Implemented Interfaces 274
Constructors 274
Fields 275
Methods 275
Inherited Methods 275
Related Documentation 275
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xiv
Contents
CiscoWideBandMediaCapability 275
Declaration 275
Constructors 276
Fields 276
Inherited Fields 276
Methods 276
Inherited Methods 276
Related Documentation 276
Interface Hierarchy 277
CiscoAddrActivatedEv 283
Superinterfaces 284
Declaration 284
Fields 284
Inherited Fields 284
Methods 284
Inherited Methods 285
Related Documentation 285
Superinterfaces 285
Declaration 285
Fields 285
Inherited Fields 285
Methods 286
Inherited Methods 286
Related Documentation 287
CiscoAddrActivatedOnTerminalEv 287
Superinterfaces 287
Declaration 287
Fields 287
Inherited Fields 288
Methods 288
Inherited Methods 288
Related Documentation 289
CiscoAddrAddedToTerminalEv 289
Superinterfaces 289
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xv
Contents
Declaration 289
Fields 289
Inherited Fields 289
Methods 290
Inherited Methods 290
Related Documentation 290
CiscoAddrAutoAcceptStatusChangedEv 290
Superinterfaces 291
Declaration 291
Fields 291
Inherited Fields 291
Methods 292
Inherited Methods 292
Related Documentation 292
CiscoAddrCreatedEv 292
Superinterfaces 292
Declaration 293
Fields 293
Inherited Fields 293
Methods 293
Inherited Methods 294
Related Documentation 294
CiscoAddrMonitorTerminatedEv 294
Declaration 294
Methods 294
Related Documentation 295
CiscoAddress 295
Superinterfaces 296
Subinterfaces 296
Fields 296
Methods 297
Inherited Methods 309
Parameters 309
Related Documentation 309
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xvi
Contents
CiscoAddressObserver 309
Superinterfaces 309
Declaration 309
Fields 309
Methods 310
Inherited Methods 310
Related Documentation 310
CiscoAddrEv 310
Superinterfaces 310
Subinterfaces 310
Declaration 310
Fields 310
Inherited Fields 311
Methods 311
Inherited Methods 311
Related Documentation 311
CiscoAddrEvFilter 311
Fields 312
Methods 312
Inherited Methods 314
Parameters 314
Value Range 314
Related Documentation 314
CiscoAddrInServiceEv 314
Superinterfaces 314
Declaration 314
Fields 314
Inherited Fields 315
Methods 315
Inherited Methods 315
Related Documentation 315
CiscoAddrIntercomInfoChangedEv 316
Superinterfaces 316
Declaration 316
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xvii
Contents
Fields 316
Inherited Fields 316
Methods 317
Inherited Methods 317
Related Documentation 317
CiscoAddrIntercomInfoRestorationFailedEv 317
Superinterfaces 318
Declaration 318
Fields 318
Inherited Fields 318
Methods 318
Inherited Methods 319
Related Documentation 319
CiscoAddrPickupGroupChangedEv 319
Declaration 319
Methods 319
New Error Code 320
CiscoAddrOutOfServiceEv 320
Superinterfaces 320
Declaration 320
Fields 320
Inherited Fields 320
Methods 321
Inherited Methods 321
Related Documentation 322
CiscoAddrParkStatusEv 322
Declaration 322
Fields 322
Inherited Fields 323
Methods 323
Value Ranges 323
Related Documentation 323
CiscoAddrRecordingConfigChangedEv 324
Superinterfaces 324
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xviii
Contents
Declaration 324
Fields 324
Inherited Fields 324
Methods 325
Inherited Methods 325
Related Documentation 325
CiscoAddrRemovedEv 325
Superinterfaces 326
Declaration 326
Fields 326
Inherited Fields 326
Methods 326
Inherited Methods 327
Related Documentation 327
CiscoAddrRemovedFromTerminalEv 327
Superinterfaces 327
Declaration 327
Fields 328
Inherited Fields 328
Methods 328
Inherited Methods 328
Related Documentation 329
CiscoAddrRestrictedEv 329
Superinterfaces 329
Declaration 329
Fields 329
Inherited Fields 330
Methods 330
Inherited Methods 330
Related Documentation 331
CiscoAddrRestrictedOnTerminalEv 331
Superinterfaces 331
Declaration 331
Fields 331
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xix
Contents
Inherited Fields 331
Methods 332
Inherited Methods 332
Related Documentation 332
CiscoAddrVoiceMailPilotChangedEv 332
Superinterfaces 333
Declaration 333
Fields 333
Inherited Fields 333
Methods 333
Inherited Methods 334
Related Documentation 334
CiscoAnnouncementStartedEv 334
Declaration 334
Methods 334
CiscoAnnouncementEndedEv 334
Declaration 334
Methods 335
CiscoAnnouncementErrorEv 335
Declaration 335
Methods 335
CiscoBaseMediaTerminal 335
Declaration 336
Superinterfaces 336
Fields 336
Inherited Fields 336
Methods 336
Inherited Methods 337
Parameters 337
Data Types 337
Range of Values 337
CiscoCall 338
Superinterfaces 339
Subinterfaces 339
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1)
xx
Contents
/