sxml > Learn > Getting Started

Getting Started

The Serviceability APIs provide an interface for the various services included in the installation of Cisco Unified Communications Manager (Cisco Unified CM) software. To begin working with Serviceability APIs, you will need Unified CM installed on a server.

DevNet registered users can access the DevNet Sandbox for development purposes. The DevNet Sandbox includes multiple labs with Unified CM already installed and configured. To learn more visit Sandbox

If you are a member of Cisco’s Solution Partner Program (SPP), you qualify for discounts on the Unified CM Not-for-Resale bundles. This program allows partners to acquire the core components of Cisco Unified Communications System for use in non-revenue generating activities such as labs, demos, and internal course development and training.

For more information about the "Not For Resale" Program, visit Membership Services Discounts.

The minimum requirements for using and testing the APIs are:

  • A Cisco Unified CM infrastructure or the Collaboration Lab in the Cisco Sandbox
  • A registered phone (optional)
  • A CTI application (optional)

Service Activation

Service Activation is handled in Cisco Unified Serviceability. Before making any API requests, ensure the service is running on Unified CM. Instructions can be found on the here:

Application User Configuration

All Serviceability APIs use HTTP 1.0 Basic access authentication which requires username and password credentials. Instructions to create an application user can be found here:

Application Preparation

Your application can use the WSDL file to generate the proper SOAP requests. The WSDL files are located on every Cisco Unified CM Publisher and Subscriber node.

SOAP Request Type URL for SOAP Requests Service Definition
RisPort70 https://ServerName:8443/realtimeservice2/services/RISService70?wsdl
PerfmonPort https://ServerName:8443/perfmonservice2/services/PerfmonService?wsdl
ControlCenterServices https://ServerName:8443/controlcenterservice2/services/ControlCenterServices?wsdl
ControlCenterServicesEx https://ServerName:8443/controlcenterservice2/services/ControlCenterServicesEx?wsdl
LogCollectionService https://ServerName:8443/logcollectionservice2/services/LogCollectionPortTypeService?wsdl
CDRonDemand https://ServerName:8443/CDRonDemandService2/services/CDRonDemandService?wsdl

With the service activated, a user created, and WSDL consumed, you are ready to make the first request. Use SoapUI to test, become familiar with, and gain a better understanding of the APIs. Refer to How To Execute Serviceability Requests with SoapUI.

When you are ready to build an application, refer to the Sample App page.

Getting Started Quick Links