RisPort Getting Started

The RisPort service is included in the installation of Cisco Unified Communications Manager (Cisco Unified CM) software. The minimum requirements for using and testing RisPort service are:

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

RisPort Service Activation

RisPort Service Activation is handled in Cisco Unified Serviceability.

Before making a RisPort request, ensure the SOAP - Real-Time Service APIs service is running.

Follow these steps to verify the service is running:

  1. From the Cisco Unified CM Administration window, select Cisco Unified Serviceability. Then click Go.
  2. Select Tools > Control Center - Network Services
  3. Scroll down to the SOAP Services section to verify SOAP - Real-Time Service APIs is running.

If needed, other services can be activated or deactivated.

To activate and configure the SOAP - Real-Time Service APIs service on all the nodes in an environment with a cluster of nodes, review the Cluster Service Activation Recommendations section of the Cisco Unified Serviceability Administration Guide.

Application User Configuration

All Serviceability APIs use HTTP 1.0 Basic access authentication which requires username and password credentials. Create an application user in Cisco Unified CM, then use those credentials to authenticate the RisPort requests.

For configuring an application user, refer to the Manage Application Users section of the Administration Guide for Cisco Unified Communications Manager and IM and Presence Service.

Application users are assigned to Access Control Groups. An application user can be assigned to:

  • An existing group
  • A newly configured group
Assigning a User to an Existing Group

To assign an application user to an existing group, select the Standard CCM Server Monitoring group. This is the default group.

Roles are assigned to groups, and users in that group are assigned roles belonging to that group. For example, Standard CCM Server Monitoring group has the three roles assigned to it. This image shows the user being associated to the group which contains those roles.

Assigning a User to a New Group

To create a new group, refer to the Manager User Access section of the Administration Guide for Cisco Unified Communications Manager and IM and Presence Service.

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. Download the WSDL for RisPort at the following URL:

https://<server>:8443/realtimeservice2/services/RISService70?wsdl

With the SOAP - Real-Time Service APIs 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 Test Serviceability with SOAPUI.

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