Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.0(1)
Third-party XMPP client application integration on IM and Presence Service
Downloads: This chapterpdf (PDF - 1.18MB) The complete bookPDF (PDF - 6.21MB) | The complete bookePub (ePub - 1.26MB) | Feedback

Third-Party XMPP Client Application Integration on IM and Presence Service

Third-Party XMPP Client Application Integration on IM and Presence Service

Third-Party Client Integration

Supported Third-Party XMPP Clients

IM and Presence Service supports standards-based XMPP to enable third-party XMPP client applications to integrate with IM and Presence Service for availability and instant messaging (IM) services. Third-party XMPP clients must comply with the XMPP standard as outlined in the Cisco Software Development Kit (SDK).

This module describes the configuration requirements for integrating XMPP clients with IM and Presence Service. If you are integrating XMPP-based API (web) client applications with IM and Presence Service, also see developer documentation for IM and Presence Service APIs on the Cisco Developer Portal:

http:/​/​developer.cisco.com/​

License Requirements for Third-Party Clients

You must assign IM and Presence Service capabilities for each user of an XMPP client application.

IM and Presence capabilities are included within both User Connect Licensing (UCL) and Cisco Unified Workspace Licensing (CUWL). Refer to the Cisco Unified Communications Manager Enterprise License Manager User Guide for more information.

XMPP Client Integration on Cisco Unified Communications Manager

Before you integrate an XMPP client, perform the following tasks on Cisco Unified Communications Manager:

  • Configure the licensing requirements.
  • Configure the users and devices. Associate a device with each user, and associate each user with a line appearance.

LDAP Integration for XMPP Contact Search

To allow users of the XMPP client applications to search and add contacts from an LDAP directory, configure the LDAP settings for XMPP clients on IM and Presence Service.

Verify Domain Name for XMPP Clients

To verify the domain name value for XMPP clients on IM and Presence Service, select Cisco Unified CM IM and Presence Administration > System > Cluster Topology, select Settings in the right pane, and verify the Domain Name value.

The domain name on the XMPP client, specifically the XMPP connection attempt domain name, must match the domain on IM and Presence Service.

DNS Configuration for XMPP Clients

You must enable DNS SRV in your deployment when you integrate XMPP clients with IM and Presence Service. The XMPP client performs a DNS SRV query to find an XMPP node (IM and Presence Service) to communicate with, and then performs a record lookup of the XMPP node to get the IP address.

Configure Secure Connection Between IM and Presence Service and XMPP Clients

Procedure
    Step 1   Choose Cisco Unified CM IM and Presence Administration > System > Security > Settings.
    Step 2   Perform one of the following tasks:
    • To establish a secure TLS connection between IM and Presence Service and XMPP client applications in a cluster, choose Enable XMPP Client To IM/P Service Secure Mode. Cisco recommends that you do not turn off this secure mode unless the XMPP client application can protect the client login credentials in a nonsecure mode. If you do turn off the secure mode, verify that you can secure the XMPP client-to-node communication in some other way.
    • To establish a secure TLS connection between IM and Presence Service and XMPP-based API client applications in a cluster, choose Enable Web Client To IM/P Service Secure Mode. If you turn on this setting, upload the certificates or signing certificates for the web client in the cup-xmpp-trust repository on IM and Presence.
    Step 3   Click Save.

    If you update the XMPP security settings, restart the following service using one of the following actions:

    • Restart the Cisco XCP Connection Manager if you edit Enable XMPP Client To IM/P Service Secure Mode. Choose Cisco Unified IM and Presence Serviceability > Tools > Control Center - Feature Services to restart this service.
    • Restart the Cisco XCP Web Connection Manager if you edit Enable Web Client To IM/P Service Secure Mode. Choose Cisco Unified IM and Presence Serviceability > Tools > Control Center - Feature Services to restart this service.

    What to Do Next

    Proceed to turn on the services that support XMPP clients on the IM and Presence Service node.

    Turn On IM and Presence Service Services to Support XMPP Clients

    Perform this procedure on each node in your IM and Presence Service cluster.

    Procedure
      Step 1   Choose Cisco Unified IM and Presence Serviceability > Tools > Service Activation.
      Step 2   Choose the IM and Presence Service node from the Server menu.
      Step 3   Turn on the following services:
      • Cisco XCP Connection Manager - Turn on this service if you are integrating XMPP clients (such as Cisco Unified Personal Communicator), or XMPP-based API clients on IM and Presence Service.
      • Cisco XCP Authentication Service - Turn on this service if you are integrating XMPP clients (such as Cisco Unified Personal Communicator), or XMPP-based API clients, or XMPP-based API clients on IM and Presence Service.
      • Cisco XCP Web Connection Manager - Optionally, turn on this service if you are integrating XMPP clients (such as Cisco Unified Personal Communicator), or XMPP-based API clients on IM and Presence Service.
      Step 4   Click Save.
      Tip   

      For XMPP clients to function correctly, make sure you turn on the Cisco XCP Router on all nodes in your cluster.