Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1)
Third-party XMPP client application integration on IM and Presence
Download this chapter
Third-party XMPP client application integration on IM and PresenceThird-party XMPP client application integration on IM and Presence
Download the complete book
Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1)Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1) (PDF - 6 MB)
 Feedback

Third-party XMPP client application integration on IM and Presence

Third-party client integration

Supported third-party XMPP clients

IM and Presence supports standards-based XMPP to enable third-party XMPP client applications to integrate with IM and Presence 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. If you are integrating XMPP-based API (web) client applications with IM and Presence, also see developer documentation for IM and Presence APIs on the Cisco Developer Portal.

Related Topic

Cisco Developer portal:

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

License requirements for third-party clients

You must assign IM and Presence 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.
Related Tasks
Related Information

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.

Related Topic

LDAP directory integration for contact searches on XMPP clients

Verify domain name for XMPP clients

The domain name on the XMPP client, specifically the XMPP connection attempt domain name, must match the domain on IM and Presence. To verify the domain value on IM and Presence, select Cisco Unified CM IM and Presence Administration > System > Cluster Topology, select Settings in the right pane, and verify the Domain Name value.

DNS configuration for XMPP clients

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

Configure secure connection between IM and Presence and XMPP clients

Procedure
    Step 1   Select Cisco Unified CM IM and Presence Administration > System > Security > Settings
    Step 2   Perform these configuration steps:

    If You Want To...

    Do This

    Establish a secure TLS connection between IM and Presence and XMPP client applications in a cluster.

    Select Enable XMPP Client To IM/P Service Secure Mode.

    We recommend that you do not turn off this secure mode unless the XMPP client application can protect the client login credentials in non-secure mode. If you do turn off the secure mode, verify that you can secure the XMPP client-to-server communication in some other way.

    Establish a secure TLS connection between IM and Presence and XMPP-based API client applications in a cluster.

    Select 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   Select Save.

    Troubleshooting Tips

    If you update the XMPP security settings, perform one of these actions:

    • Restart the following services:
    • Restart the Cisco XCP Connection Manager if you edit Enable XMPP Client To IM/P Service Secure Mode. SelectCisco 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. SelectCisco Unified IM and Presence Serviceability > Tools > Control Center - Feature Services to restart this service
    What to Do Next

    Turn on IM and Presence Services to support XMPP clients

    Related Information

    Turn on IM and Presence Services to support XMPP clients


    Note

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

    Procedure
      Step 1   Select Cisco Unified IM and Presence Serviceability > Tools > Service Activation.
      Step 2   Select the IM and Presence server 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
      • 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.
      • 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.
      Step 4   Select Save.

      Troubleshooting Tip

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

      Related Tasks
      Related Information