Cisco Unified Communications Manager XML Developers Guide, Release 9.0(1) Copyright © 2006–2012 Cisco Systems, Inc
Total Page:16
File Type:pdf, Size:1020Kb
Cisco Unified Communications Manager XML Developers Guide Release 9.0(1) 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 Text Part Number: OL-27400-01 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. Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. 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. (1005R) Cisco Unified Communications Manager XML Developers Guide, Release 9.0(1) Copyright © 2006–2012 Cisco Systems, Inc. All rights reserved. Preface ix Purpose ix Audience x Organization xi Related Documentation xii Cisco Developer Network xiii Conventions xiv Obtaining Documentation and Submitting a Service Request xv Cisco Product Security Overview xv 1 Overview 1 Cisco Unified Communications Manager Interfaces 1 Provisioning Interfaces 1 Device Monitoring and Call Control Interfaces 2 Serviceability Interfaces 3 Routing Rules Interface 4 Development Guidelines 4 What is New in Cisco Unified Communications Manager 9.0(1) API 5 Administrative XML API 5 Serviceability XML API 11 Extension Mobility API 12 Web Dialer API 12 Routing Rules API 12 1 Administrative XML 1 1 Administrative XML Programming 1 Overview 2 New and Changed Information 3 New and Changed Information in Unified CM Release 9.0 3 New and Changed Information in Previous Releases of Unified CM 8 New Information for Unified CM 5.0(1) 134 AXL Schema Documentation 138 AXL Versioning Support 139 Authentication 142 Data Encryption 142 Dynamic Throttling of Requests 143 AXL Data Throttling 144 Integration Considerations and Interoperability 150 Post-Installation Steps and Troubleshooting on the Linux Platform 151 Post-Installation Steps 151 Post-Installation Troubleshooting Checklist 152 AXL Trace Logs 153 Using the AXL API with AXIS 155 Using the AXL API in a .NET Environment 156 Required Changes to the Generated Code 156 Backward Compatibility Issues 157 Tag Serialization Issues 158 Names Containing Special Characters 159 Returned Namespace for AXIS and .NET Applications 159 Example AXL Requests 160 C or C++ Example 161 Java Example 165 Using executeSQLUpdate 167 Using executeSQLQuery 167 AXL Error Codes 168 1 Serviceability XML 1 1 Serviceability XML Programming 1 Overview 2 New and Changed Information 2 New Information for Unified CM 9.0(1) 2 New and Changed Information in Previous Releases of Unified CM 3 Data Model 16 SOAP Binding 16 Namespaces 22 Downloading Serviceability SOAP WSDL Files 22 Monitoring SOAP Activity 23 RisPort SOAP Service 24 RisPort Service: selectCmDevice Operation 25 RisPort Service: SelectCmDeviceExt Operation 33 RisPort Service: SelectCmDevice Operation (Includes IPv6 Devices) 36 RisPort Service: selectCtiItem Operation 69 RisPort Service: SelectCtiDevice Operation (Includes IPv6 Devices) 73 RisPort Service: getServerInfo Operation 84 RisPort Service: SelectCmDeviceSIP Operation 93 Interface to Get Server Names and Cluster Name 109 PerfmonPort SOAP Service 110 PerfmonPort Service: perfmonOpenSession Operation 111 PerfmonPort Service: perfmonAddCounter Operation 112 PerfmonPort Service: perfmonRemoveCounter Operation 115 PerfmonPort Service: perfmonCollectSessionData Operation 118 PerfmonPort Service: perfmonCloseSession Operation 120 PerfmonPort Service: perfmonListInstance Operation 122 PerfmonPort Service: perfmonQueryCounterDescription Operation 125 PerfmonPort Service: perfmonListCounter Operation 126 PerfmonPort Service: perfmonCollectCounterData Operation 177 ControlCenterServicesPort SOAP Service 186 ControlCenterServicesPort service: soapGetStaticServiceList Operation 186 ControlCenterServicesPort service: soapGetServiceStatus Operation 199 ControlCenterServicesPort service: soapDoServiceDeployment Operation 214 ControlCenterServicesPort service: soapDoControlServices Operation 220 ControlCenterServicesPort service: getProductInformationList Operation 225 ControlCenterServicesPort service: soapGetfileDirectoryList Operation 247 ControlCenterServicesPort service: soapGetStaticServiceListExtended Operation 247 ControlCenterServicesPort service: soapDoControlServiceEx Operation 250 ControlCenterServicesPort service: soapDoServiceDeploymentNoDbUpdate Operation 251 LogCollectionPort SOAP Service 252 LogCollectionPort service: listNodeServiceLogs Operation 252 LogCollectionPort Service: selectLogFiles Operation 259 CDRonDemand SOAP Service 269 Security Considerations for CDRonDemand Service 273 CDRonDemand Service: get_file_list Operation 274 CDRonDemand Service: get_file Operation 275 DimeGetFileService SOAP Service 278 DimeGetFileService SOAP Service: getOneFile Operation 278 VersionService 279 Authentication 280 Basic 280 Secure 280 Authorization 281 Developer Tools 281 View Deployed Web Services 282 View <Web Service> WSDL 283 SOAP Monitor 284 Password Expiration and Lockout 284 Application Customization for Cisco Unity Connection Servers 284 SOAP Service Tracing 285 Serviceability XML API Authentication Security 286 Rate Control Mechanism 286 SOAP Fault Error Codes 287 Fault Strings 288 Sample SOAP Fault or AXIS Fault 292 Serviceability XML Application Design Guidelines and Best Practices 294 Maintain HTTPs sessions and Connection Timeouts 294 Send Perfmon Close Session 294 Device Query Support for Large Clusters 295 Respond and React to SOAP Faults 297 Limit Request and Response Size in the Application Design 297 Number of Nodes in the Cluster 297 SOAP Monitor Usage 297 Locations Topology XML Schema 297 XML Schema Definition 298 1 Extension Mobility Service API 1 1 Cisco Extension Mobility Service API 1 Overview 1 New and Changed Information 2 New Information for Cisco Unified Communications Manager 9.0(1) 2 New and Changed Information in Previous Releases of Unified CM 2 How Cisco Extension Mobility Works 3 Device Profiles 4 Using the Cisco Extension Mobility API 4 Set Up and Configuration 5 Messages 5 Message Document Type Definitions 6 Message Examples 8 Login Operation 8 Logout Operation 9 LogoutAll Operation 10 UserQuery Operation 10 DeviceQuery Operation 11 Device Profile Query 11 Extension Mobility Service Response Codes 12 1 Web Dialer API 1 1 Cisco Web Dialer API Programming 1 Overview 1 New and Changed Information 2 New Information for Cisco Unified Communications Manager 9.0(1) 2 New and Changed Information in Previous Releases of Unified CM 2 Cisco Web Dialer Components 3 Cisco Web Dialer Servlet 4 Redirector Servlet 4 Cisco Web Dialer Security Support 5 Security Service Parameters 6 Maximum Concurrent Call Requests 7 Phone Support For Cisco Web Dialer 7 Call Flows 10 Desktop-based Client Application Call Flow 11 Browser-Based Application Call Flow 12 Interfaces 14 SOAP Over HTTPS Interface 14 HTML Over HTTPS Interfaces 24 Cisco Web Dialer WSDL 26 Sample Code Snippet 30 1 Routing Rules API 1 1 Cisco Unified Routing Rules Interface 1 Overview 2 New and Changed Information 2 New Information for Cisco Unified Communications Manager 9.0(1) 2 New and Changed Information in Previous Releases of Unified CM 3 Call Routing Request 3 Description 3 Format 4 Parameters 5 Example 5 XACML Request Schema 7 Call Routing Response 9 Description 9 Format 9 Parameter 10 CIXML Format 12 CIXML Parameter 14 Example 16 XACML Response Schema 16 CIXML Schema 18 Keep-Alive Message 20 Message Timer 21 Connections 21 Multiple Connections 21 Redundant Web Services 22 Persistent Connection and Keep-Alive 22 Redirection 22 Error Handling 23 Web Service Connection Failure 23 Unified CM Timeout Awaiting Response from Web Service 23 Error Response from Web Service 24 Web Service Parse Request Error 24 Unified CM Parse Response Error 24 Web Service Evaluation Request Error 25 Security 25 Authentication 25 Certificate and Key 26 Transport Layer Security Version 26 Cipher Specification