Unified Communications Manager (CallManager)

Cisco Unified Communications Manager (CallManager), Unified Communications Manager Version 11.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 11.5(1)
First Published: 2015-09-01
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
Full Cisco Trademarks with Software License ?
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
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
iii
Provider.getTerminals() 9
Provider.getAddresses() 9
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 11.5(1) 19
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 JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
iv
Contents
Cisco Unified Communications Manager Release 5.0 26
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 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 43
CallSelect and UnSelect Event Notification 44
Certificate Download API Enhancement 44
Changes in DeviceType Name Handling 45
Cisco MediaTerminal 45
Provisioning 46
Registration 46
Adding Observers 47
Accepting Calls 48
Cisco Unified Communications Manager Media Endpoint Model 48
Payload and Parameter Negotiation 48
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
v
Contents
Initialization 49
Payload Selection 49
Receive Channel Allocation 49
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 52
Errors 53
CiscoProvAuthenticationInfoEv 54
CiscoRTPHandle Interface on Cisco RTP Events 54
Cisco Terminal Filter and ButtonPressedEvents 54
CiscoTermRegistrationfailed Event 55
Errors 56
Cius Persistency 56
Clear Calls 58
Click to Conference 58
Cluster Abstraction 58
Command Line Invocation 59
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 64
Consult Without Media 65
CTI Ports 66
CTI RoutePoints 66
CTI Remote Device for JTAPI 66
Play Announcement 67
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
vi
Contents
Verify Remote Destination Support 68
NuRD (Number Matching for Remote Destination) Support 69
Mobility Interaction Support 69
CTI RD Call Forward 70
CTI Video Support 70
Default CTI IP Addressing for Devices 72
DeleteCall 72
Device Recovery 72
Device Recovery for Phones 73
Device State Server 73
Direct Transfer Across Lines 74
Usage Guidelines 74
Event Flow Comparison and Sample Code 75
Directed Call Park 79
Directory Change Notification 80
Do Not Disturb 80
Do Not Disturb-Reject 81
Drop Any Party 82
Dynamic CTI Port Registration 83
E911 Teleworker 85
Enable or Disable Ringer 85
Encryption Enhancement 86
End to End Call Tracing 86
EnergyWise Deep Sleep Mode 87
Extension Mobility Cross Cluster 89
Extension Mobility Username Login 90
External Call Control 90
End to End Session ID for Calls 91
FIPS Compliance 92
Forced Authorization and Client Matter Codes 93
Supported Interfaces 94
Call.Connect() and Call.Consult() 94
Call.transfer(String) and Connection.redirect() 95
RouteSession.selectRoute() 95
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
vii
Contents
Forwarding on No Bandwidth and Unregistered DN 96
GetCallID in RTP Events 96
GetCallInfo 96
GetGlobalCallID 97
Hairpin Support 97
Half-Duplex Media Support 98
Hold Reversion 99
Hunt List 99
Hunt List Connected Number 100
Hunt Log Status 101
Intercom 102
Intercom Support for Extension Mobility 104
IPv6 Support 104
iSac Codec 105
Java Socket Connect Timeout 106
Join Across Lines 106
Join Across Lines (Only SCCP) 107
Join Across Lines or Connected Conference Across Lines 107
Usage Guidelines 107
Event Flow Comparison and Sample Code 108
Join Across Lines with Conference Enhancements (SCCP and SIP) 112
JRE 1.2 and JRE 1.3 Support Removal 113
JTAPI Version Information 114
Locale Infrastructure Development 114
Logical Partitioning 115
Media Termination at Route Point 115
Media Termination Extensions 117
Message Waiting Indicator Enhancement 118
Modifying Calling Number 119
Multilevel Precedence and Preemption Support 120
Multiple Calls Per DN 121
Native Queuing 121
Network Alerting 122
Network Events 123
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
viii
Contents
New Error Code in CiscoTermRegistrationFailedEv 124
Noncontroller Adding of Parties to Conferences 124
Park DN Monitor 124
Park Monitoring and Assisted DPark Support 125
Park Reminder 127
Park Retrieval 127
Partition Support 127
Password Expiry 130
Persistent Connection 130
Play Zip Tone 132
Presentation Indicator for Calls 133
Privacy On Hold 134
Progress State Converted to Disconnect State 135
Q.Signaling (QSIG) Path Replacement 135
QoS Support 135
QoS Setup on Windows 2000 136
QoS Setup on Windows XP Server 2003 137
Quiet Clear 137
Receiving and Responding to Media Flow Events 138
Inbound Call Media Flow Event Diagram 138
Cisco Unified Communications Solutions RTP Implementation 139
Recording 139
Redirect 142
Redirect Set Original Called ID 143
Redirect to Device 144
Redundancy 145
Redundancy in CTI Managers 145
Invoking CTIManager Redundancy 146
CTIManager Failure 147
Heartbeats 147
Ringback on SIP 183 for Transferred Calls 147
Routing 148
Cisco Route Session Implementation 148
Select Route Timer 149
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
ix
Contents
Forwarding Timer 149
Route Session Extension 149
Caller Options Summary 150
Fault Tolerance When Using Route Points 150
Secure Conferencing 150
Secure Real-Time Protocol Key Material 151
Secured Monitoring and Recording 157
SelectRoute Interface Enhancement 158
selectRoute() with Calling Search Space and Feature Priority 159
Set MessageWaiting 159
Shared Line Support 160
Silent Monitoring 162
Single Sign-On 165
Single Step Transfer 166
SIP 3XX Redirection 167
SIP Phone Support 168
SIP REFER or REPLACE 171
SIP Trunk Early Offer 172
Star (*) 50 Update 175
Super Provider (Disable Device Validation) 175
Superprovider and Change Notification 176
Support for Cisco Unified IP Phone 6901 178
Support for Cisco Unified IP Phone 6900 Series 179
Support for 100+ Directory Numbers 180
Support for VMware 181
Swap or Cancel and Transfer or Conference Behavior 182
Terminal and Address Capability Settings 183
Terminal and Address Restrictions 184
SHA-512 Support for Digital Signatures 188
Transfer 188
CiscoTransferStartEv 188
CiscoTransferEndEv 189
Transfer Scenarios 189
Transfer and Conference Extensions 191
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
x
Contents
Transfer and DirectTransfer 191
Translation Pattern Support 192
Transport Layer Security (TLS) 193
Unicode Support 199
Unrestricted Unified CM 201
URI Dialing 202
Version Format Change 203
Verification Involving PSTN Reachability 203
Video Capabilities and Multi-Media Information 203
Exposing Multimedia Capability on CiscoTerminal 203
Exposing Changes in Multimedia Capability Via a New Provider Event 204
Exposing Multimedia Capability on a CiscoCall 204
Exposing Multimedia Streams Information on CiscoTerminal 204
Supported Features (Within the Same Cluster) 205
Supported Features (Across Clusters) 206
Limitations 206
Video On Hold Support 207
Voice MailBox Support 207
XSI Object Pass Through 208
CiscoTerminal Method 208
Authentication and Mechanism 209
Cisco Unified JTAPI Installation 211
CHAPTER 4
Overview 211
Required Software 212
Supported Platforms 212
Installing the Cisco Unified JTAPI Software 212
Silent Install Invocation 213
Command Line Invocation 213
End User Installation 214
Installation Procedures 215
Linux Platforms 221
Verifying Linux Installation 223
Windows Platforms 223
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xi
Contents
Installing Cisco JTAPI on 32 bit Windows Platforms 225
Installing Cisco JTAPI on 64 bit Windows Platforms 229
Verifying Windows Installation 233
Determining the Current JTAPI Version 233
Linux and Windows Installation 234
Using Cisco Unified CM JTAPI 235
Program Group and Program Elements 235
Cisco Unified JTAPI Configuration Settings 235
JTAPI Tracing Tab 236
Log Destination Tab 237
Cisco Unified CM Tab 240
Advanced Tab 241
Security Tab 244
Language Tab 246
Managing the Cisco Unified CM JTAPI 248
Reinstalling, Upgrading or Downgrading the Cisco JTAPI 248
Uninstalling the Cisco JTAPI 248
Administering User Information for JTAPI Applications 249
Fields in the jtapi.ini File 249
Sample jtapi.ini File with Default Values 255
Hierarchy for All Cisco Unified JTAPI Packages 257
CHAPTER 5
Class Hierarchy 257
Interface Hierarchy 258
Cisco Unified JTAPI Extensions 267
CHAPTER 6
Class Hierarchy 271
CiscoAddressCallInfo 271
Declaration 271
Constructors 272
Fields 272
Methods 272
Inherited Methods 272
Related Documentation 272
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xii
Contents
CiscoG711MediaCapability 273
Declaration 273
Constructors 273
Fields 273
Inherited Fields 274
Methods 274
Inherited Methods 274
Related Documentation 274
CiscoG723MediaCapability 274
Declaration 274
Constructors 275
Fields 275
Inherited Fields 275
Methods 275
Inherited Methods 276
Related Documentation 276
CiscoG729MediaCapability 276
Declaration 276
Constructors 276
Fields 277
Inherited Fields 277
Methods 277
Inherited Methods 277
Related Documentation 277
CiscoGSMMediaCapability 277
Declaration 278
Constructors 278
Fields 278
Inherited Fields 278
Methods 278
Inherited Methods 279
Related Documentation 279
CiscoJtapiVersion 279
Declaration 279
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xiii
Contents
Constructors 279
Fields 279
Methods 280
Inherited Methods 280
Related Documentation 280
CiscoMediaCapability 280
Declaration 281
Subclasses 281
Constructors 281
Fields 281
Methods 282
Inherited Methods 282
Related Documentation 282
CiscoMultiMediaCapabilityInfo 282
Declaration 282
Fields 283
Methods 283
CiscoRegistrationException 283
Declaration 284
Implemented Interfaces 284
Constructors 284
Methods 284
Inherited Methods 284
Related Documentation 284
CiscoRTPParams 285
Declaration 285
Constructors 285
Fields 285
Methods 285
Inherited Methods 286
Related Documentation 286
CiscoUnregistrationException 286
Declaration 286
Implemented Interfaces 286
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xiv
Contents
Constructors 286
Fields 287
Methods 287
Inherited Methods 287
Related Documentation 287
CiscoWideBandMediaCapability 287
Declaration 287
Constructors 288
Fields 288
Inherited Fields 288
Methods 288
Inherited Methods 288
Related Documentation 288
Interface Hierarchy 289
CiscoAddrActivatedEv 295
Superinterfaces 296
Declaration 296
Fields 296
Inherited Fields 296
Methods 296
Inherited Methods 297
Related Documentation 297
Superinterfaces 297
Declaration 297
Fields 297
Inherited Fields 297
Methods 298
Inherited Methods 298
Related Documentation 299
CiscoAddrActivatedOnTerminalEv 299
Superinterfaces 299
Declaration 299
Fields 299
Inherited Fields 300
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xv
Contents
Methods 300
Inherited Methods 300
Related Documentation 301
CiscoAddrAddedToTerminalEv 301
Superinterfaces 301
Declaration 301
Fields 301
Inherited Fields 301
Methods 302
Inherited Methods 302
Related Documentation 302
CiscoAddrAutoAcceptStatusChangedEv 302
Superinterfaces 303
Declaration 303
Fields 303
Inherited Fields 303
Methods 304
Inherited Methods 304
Related Documentation 304
CiscoAddrCreatedEv 304
Superinterfaces 304
Declaration 305
Fields 305
Inherited Fields 305
Methods 305
Inherited Methods 306
Related Documentation 306
CiscoAddrMonitorTerminatedEv 306
Declaration 306
Methods 306
Related Documentation 307
CiscoAddress 307
Superinterfaces 308
Subinterfaces 308
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xvi
Contents
Fields 308
Methods 309
Inherited Methods 321
Parameters 321
Related Documentation 321
CiscoAddressObserver 321
Superinterfaces 321
Declaration 321
Fields 321
Methods 322
Inherited Methods 322
Related Documentation 322
CiscoAddrEv 322
Superinterfaces 322
Subinterfaces 322
Declaration 322
Fields 322
Inherited Fields 323
Methods 323
Inherited Methods 323
Related Documentation 323
CiscoAddrEvFilter 323
Fields 324
Methods 324
Inherited Methods 326
Parameters 326
Value Range 326
Related Documentation 326
CiscoAddrInServiceEv 326
Superinterfaces 326
Declaration 326
Fields 326
Inherited Fields 327
Methods 327
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xvii
Contents
Inherited Methods 327
Related Documentation 327
CiscoAddrIntercomInfoChangedEv 328
Superinterfaces 328
Declaration 328
Fields 328
Inherited Fields 328
Methods 329
Inherited Methods 329
Related Documentation 329
CiscoAddrIntercomInfoRestorationFailedEv 329
Superinterfaces 330
Declaration 330
Fields 330
Inherited Fields 330
Methods 330
Inherited Methods 331
Related Documentation 331
CiscoAddrPickupGroupChangedEv 331
Declaration 331
Methods 331
New Error Code 332
CiscoAddrOutOfServiceEv 332
Superinterfaces 332
Declaration 332
Fields 332
Inherited Fields 332
Methods 333
Inherited Methods 333
Related Documentation 334
CiscoAddrParkStatusEv 334
Declaration 334
Fields 334
Inherited Fields 335
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xviii
Contents
Methods 335
Value Ranges 335
Related Documentation 335
CiscoAddrRecordingConfigChangedEv 336
Superinterfaces 336
Declaration 336
Fields 336
Inherited Fields 336
Methods 337
Inherited Methods 337
Related Documentation 337
CiscoAddrRemovedEv 337
Superinterfaces 338
Declaration 338
Fields 338
Inherited Fields 338
Methods 338
Inherited Methods 339
Related Documentation 339
CiscoAddrRemovedFromTerminalEv 339
Superinterfaces 339
Declaration 339
Fields 340
Inherited Fields 340
Methods 340
Inherited Methods 340
Related Documentation 341
CiscoAddrRestrictedEv 341
Superinterfaces 341
Declaration 341
Fields 341
Inherited Fields 342
Methods 342
Inherited Methods 342
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xix
Contents
Related Documentation 343
CiscoAddrRestrictedOnTerminalEv 343
Superinterfaces 343
Declaration 343
Fields 343
Inherited Fields 343
Methods 344
Inherited Methods 344
Related Documentation 344
CiscoAddrVoiceMailPilotChangedEv 344
Superinterfaces 345
Declaration 345
Fields 345
Inherited Fields 345
Methods 345
Inherited Methods 346
Related Documentation 346
CiscoAnnouncementStartedEv 346
Declaration 346
Methods 346
CiscoAnnouncementEndedEv 346
Declaration 346
Methods 347
CiscoAnnouncementErrorEv 347
Declaration 347
Methods 347
CiscoBaseMediaTerminal 347
Declaration 348
Superinterfaces 348
Fields 348
Inherited Fields 348
Methods 348
Inherited Methods 349
Parameters 349
Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager, Release 11.5(1)
xx
Contents
/