Contents
- Cisco SIP Proxy Server Integration Guide for Cisco Unity Connection Release 11.x
- Prerequisites
- Phone System
- Cisco Unity Connection Server
- Network Configuration
- Integration Tasks
- Task List to Create the Integration
- Integration Description
- Call Information
- Integration Functionality
- Integrations with Multiple Phone Systems
- Planning the Usage of Voice Messaging Ports
- Voice Messaging Ports to Install
- Voice Messaging Ports that Answer Calls
- Voice Messaging Ports that Dial Out
- Considerations for a Unity Connection Cluster
- When Both Unity Connection Servers are Functioning Normally
- When Only One Unity Connection Server is Functioning
- Programming the Cisco SIP Proxy Server Phone System
- Configure SIP Gateway Servicing Unity Connection
- Configuring Application Session on the SIP Gateway
- Disabling the SIP Media Inactivity Timer
- Enabling DTMF Relay for SIP Calls by Using Named Telephony Events
- Creating a New Integration with the Cisco SIP Proxy Server Phone System
- Testing the Integration
- Setting Up the Test Configuration
- Testing an External Call with Release Transfer
- Testing Listening to Messages
- Setting Up Supervised Transfer on Unity Connection
- Testing Supervised Transfer
- Adding New User Templates for Multiple Integrations
- Compatibility of Phone System Components
Cisco SIP Proxy Server Integration Guide for Cisco Unity Connection Release 11.x
Published May, 2015
This document provides instructions for integrating a Cisco SIP Proxy Server phone system with Cisco Unity Connection.
Prerequisites
Phone System
Cisco SIP Proxy Server-enabled phones (for example, SIP-enabled Cisco IP Phone 7960 or Pingtel xpressa).
The SIP phones must use the REFER method for call transfers.
SIP-enabled gateways (for example, Cisco AS5300 Access Server, Cisco 2600 series router, or Cisco 3600 series router) for access to the PSTN.
For details on compatibility of the phone system components with the integration, see the Compatibility of Phone System Components.
Cisco Unity Connection Server
Unity Connection installed and ready for the integration, as described in the Install, Upgrade, and Maintenance Guide for Cisco Unity Connection at https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/11x/install_upgrade/guide/b_11xcuciumg.html.
A license that enables the applicable number of voice messaging ports.
Integration Tasks
Before doing the following tasks to integrate Cisco Unity Connection with a Cisco SIP Proxy Server phone system, confirm that Unity Connection is ready for the integration by completing the applicable tasks in the "Installing Cisco Unity Connection” chapter of the Install, Upgrade, and Maintenance Guide for Cisco Unity Connection, Release 11.x, available at https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/11x/install_upgrade/guide/b_11xcuciumg.html.
The following task list describes the process for creating the integration.
Task List to Create the Integration
Use the following task list to integrate Unity Connection with the Cisco SIP Proxy Server phone system.
Review the system and equipment requirements to confirm that all phone system and Unity Connection server requirements have been met. See the “Prerequisites” section on page 1.
Plan how the voice messaging ports are used by Unity Connection. See the “Planning the Usage of Voice Messaging Ports” section on page 4.
Program the Cisco SIP Proxy Server phone system. See the “Programming the Cisco SIP Proxy Server Phone System” section on page 7.
Set up the SIP gateway that services Unity Connection. See the “Configure SIP Gateway Servicing Unity Connection” section on page 7.
Create the integration. See the “Creating a New Integration with the Cisco SIP Proxy Server Phone System” section on page 8.
Test the integration. See the “Testing the Integration” section on page 11.
If this integration is a second or subsequent integration, add the applicable new user templates for the new phone system. See the “Adding New User Templates for Multiple Integrations” section on page 15.
Note
While integrating the Cisco Unity Connection with Cisco Unified Call Manager through a SIP Proxy Server uncheck the Synchronize guest time to host option for Unified Communications product line in Virtualized environment. This enables the Unified Communications to synchronize with their clock to external NTP servers.Integration Description
The Cisco SIP Proxy Server integration uses the SIP proxy server to set up communications between the voice messaging ports on the Unity Connection server and the applicable end point (for example, a SIP-enabled phone). The communications occur through:
An IP network (LAN, WAN, or Internet) to all SIP-enabled devices connected to it.
A SIP-enabled gateway to the PSTN and all phones connected to it.
Figure 1 shows the connections.
Figure 1. Connections Between the Cisco SIP Proxy Server Phone System and Unity ConnectionCall Information
The proxy server integration sends the following information in the SIP message with calls forwarded:
In the Diversion header, the reason for the forward (the extension is busy, does not answer, or is set to forward all calls)
In the From header, the extension of the calling party (for internal calls) or the SIP URL of the calling party (if it is an external call and the system uses caller ID)
Unity Connection uses this information to answer the call appropriately. For example, a call forwarded to Unity Connection is answered with the personal greeting of the user. If the phone system routes the call to Unity Connection without this information, Unity Connection answers with the opening greeting.
Integration Functionality
The Cisco SIP Proxy Server integration with Unity Connection provides the following features:
Easy message access (a user can retrieve messages without entering an ID; Cisco Unity Connection identifies a user based on the extension from which the call originated; a password may be required)
Identified user messaging (Cisco Unity Connection identifies a user who leaves a message during a forwarded internal call, based on the extension from which the call originated)
Integrations with Multiple Phone Systems
When Unity Connection is installed as Cisco Business Edition—on the same server with Cisco Unified Communications Manager—Unity Connection cannot be integrated with multiple phone systems at one time.
When Unity Connection is not installed as Cisco Business Edition, Unity Connection can be integrated with multiple phone systems at one time. For information on and instructions for integrating Unity Connection with multiple phone systems, see the Multiple Phone System Integration Guide for Cisco Unity Connection Release 11.x at https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/11x/integration/guide/multiple_integration/b_cuc11xintmultiple.html.
Planning the Usage of Voice Messaging Ports
Before programming the phone system, you need to plan how the voice messaging ports are used by Unity Connection.
Unlike other integrations, the hunt group mechanism for a Cisco SIP Proxy Server integration is implemented on the Unity Connection server. Within a port group, each incoming call hunts for an available voice messaging port among all the ports in a round-robin (or circular) fashion. If a voice messaging port in the port group is set not to answer calls or is not enabled, a call reaching that port may receive a busy signal.
The following considerations affect the programming for the phone system (for example, setting up the hunt group or call forwarding for the voice messaging ports):
- For a Unity Connection cluster, each Unity Connection server must have enough ports to handle all voice messaging traffic in case the other server stops functioning.
The number of voice messaging ports that only dial out, for example, to send message notification, to set message waiting indicators (MWIs), and to make telephone record and playback (TRAP) connections.
The following table describes the voice messaging port settings in Unity Connection that can be set on Telephony Integrations > Port of Cisco Unity Connection Administration.
Voice Messaging Ports to Install
The number of voice messaging ports to install depends on numerous factors, including:
The number of calls Unity Connection answer when call traffic is at its peak.
The expected length of each message that callers record and that users listen to.
The number of MWIs that are activated when call traffic is at its peak.
The number of TRAP connections needed when call traffic is at its peak. (TRAP connections are used by Cisco Unity Connection web applications to play back and record over the phone.)
The number of calls that use the automated attendant and call handlers when call traffic is at its peak.
Whether a Cisco Unity Connection cluster is configured. For considerations, see the “Considerations for a Unity Connection Cluster” section on page 6.
It is best to install only the number of voice messaging ports that are needed so that system resources are not allocated to unused ports.
Voice Messaging Ports that Answer Calls
The calls that the voice messaging ports answer can be incoming calls from unidentified callers or from users. Assign all of the voice messaging ports to answer calls.
You can set voice messaging ports to both answer calls and to dial out (for example, to send message notifications).
If your system is configured for a Cisco Unity Connection cluster, see the “Considerations for a Unity Connection Cluster” section on page 6.
Voice Messaging Ports that Dial Out
Ports that only dial out can do one or more of the following:
Notify users by phone, pager, or email of messages that have arrived.
Make a TRAP Unity Connection so that users can use the phone as a recording and playback device in Cisco Unity Connection web applications.
If your system is configured for a Cisco Unity Connection cluster, see the “Considerations for a Unity Connection Cluster” section on page 6.
Considerations for a Unity Connection Cluster
If your system is configured for a Unity Connection cluster, consider how the voice messaging ports are used in different scenarios.
When Both Unity Connection Servers are Functioning Normally
A hunt group is configured on the phone system to distribute calls equally to both Unity Connection servers.
The network is configured to send incoming calls first to the subscriber server, then to the publisher server if no answering ports are available on the subscriber server.
Both Unity Connection servers are active and handle voice messaging traffic for the system.
In Cisco Unity Connection Administration, the voice messaging ports are configured so that an equal number of voice messaging ports are assigned to each Unity Connection server. This guide directs you to assign the voice messaging ports to their specific server at the applicable time.
The number of voice messaging ports that are assigned to one Unity Connection server must be sufficient to handle all of the voice messaging traffic for the system (answering calls and dialing out) when the other Unity Connection server stops functioning.
If both Unity Connection servers must be functioning to handle the voice messaging traffic, the system do not have sufficient capacity when one of the servers stops functioning.Each Unity Connection server is assigned half the total number of voice messaging ports.
If all the voice messaging ports are assigned to one Unity Connection server, the other Unity Connection server is not able to answer calls or to dial out.Each Unity Connection server must have voice messaging ports that answer calls and that can dial out (for example, to set MWIs).
When Only One Unity Connection Server is Functioning
The hunt group on the phone system sends all calls to the functioning Unity Connection server.
The functioning Unity Connection server receives all voice messaging traffic for the system.
The number of voice messaging ports that are assigned to the functioning Unity Connection server must be sufficient to handle all of the voice messaging traffic for the system (answering calls and dialing out).
The functioning Unity Connection server must have voice messaging ports that answer calls and that can dial out (for example, to set MWIs).
If the functioning Unity Connection server does not have voice messaging ports for answering calls, the system is not able to answer incoming calls. Similarly, if the functioning Unity Connection server does not have voice messaging ports for dialing out, the system will not be able to dial out (for example, to set MWIs).Programming the Cisco SIP Proxy Server Phone System
ProcedureIf you use programming options other than those supplied in the following procedure, the performance of the integration may be affected. Do the following procedure to program the Cisco SIP Proxy Server Phone System.
Step 1 Install and set up the Cisco SIP Proxy Server as described in the server documentation: Task List to Create the Integration Step 2 For a Cisco Unity Connection cluster, identify the Unity Connection servers with a fully qualified domain name (FQDN), and configure a DNS server to resolve the FQDN to the IP addresses and SIP ports of the Cisco Unity Connection server. Step 3 Program each phone to forward calls to <the contact line name>@<SIP proxy server>, the voice messaging line name that users will use to contact Unity Connection. Step 4 If Unity Connection will authenticate with the Cisco SIP Proxy Server, enter a user record for the contact line name that Unity Connection will use.
Configure SIP Gateway Servicing Unity Connection
To configure the SIP gateway for the SIP integration with Cisco Unity Connection, do the following three procedures.
Configuring Application Session on the SIP Gateway
Procedure
Step 1 On the VoIP dial-peer servicing Unity Connection, use the following command: application sessionStep 2 Create a destination pattern that matches the voice messaging port numbers. For example, if the system has voice messaging ports 1001 through 1016, enter the dial-peer destination pattern 10xx. Step 3 Repeat Step 1 and Step 2 for all remaining VoIP dial-peers servicing Cisco Unity Connection.
Disabling the SIP Media Inactivity Timer
Procedure
Enabling DTMF Relay for SIP Calls by Using Named Telephony Events
Procedure
Creating a New Integration with the Cisco SIP Proxy Server Phone System
ProcedureAfter ensuring that Cisco SIP Proxy Server phone system and Cisco Unity Connection are ready for the integration, do the following procedure to set up the integration and to enter the port settings.
Step 1 In Cisco Unity Connection Administration, expand Telephony Integrations, then select Phone System. Step 2 On the Search Phone Systems page, under Display Name, select the name of the default phone system. Step 3 On the Phone System Basics page, in the Phone System Name field, enter the descriptive name that you want for the phone system. Step 4 If you want to use this phone system as the default for TRaP connections so that administrators and users without voicemail boxes can record and playback through the phone in Unity Connection web applications, check the Default TRAP Switch check box. If you want to use another phone system as the default for TRaP connections, uncheck this check box. Step 5 Select Save. Step 6 On the Phone System Basics page, in the Related Links drop-down box, select Add Port Group and select Go. Step 7 On the New Port Group page, enter the applicable settings and select Save.
Table 2 Settings for the New Port Group Page Select the name of the phone system that you entered in Step 3.
Select Port Group Template and select SIP in the drop-down box.
Enter a descriptive name for the port group. You can accept the default name or enter the name that you want.
If you want Unity Connection to authenticate with the Cisco SIP Proxy Server, check this check box.
Enter the name that Unity Connection will use to authenticate with the Cisco SIP Proxy Server.
Enter the password that Unity Connection will use to authenticate with the Cisco SIP Proxy Server.
Enter the voice messaging line name that users will use to contact Unity Connection and that Unity Connection will use to register with the Cisco SIP Proxy Server.
Select the SIP transport protocol that Cisco Unity Connection will use.
Enter the IP address (or host name) of the primary Cisco SIP Proxy Server that you are integrating with Cisco Unity Connection.
Enter the IP port of the primary gateway that you are connecting to Unity Connection. We recommend that you use the default setting.
Caution This setting must match the port setting of the gateway. Otherwise the integration will not function correctly. Step 8 On the Port Group Basics page, do the following substeps if there is a secondary Cisco SIP Proxy Server. Otherwise, continue to Step 9.
Step 9 On the Port Group Basics page, in the Related Links drop-down box, select Add Ports and select Go. Step 10 On the New Port page, enter the following settings and select Save.
Table 4 Settings for the New Ports Page Enter the number of voice messaging ports that you want to create in this port group.
Note For a Cisco Unity Connection cluster, you must enter the total number of voice messaging ports that will be used by all Cisco Unity Connection servers. Each port will later be assigned to a specific Cisco Unity Connection server. Select the name of the phone system that you entered in Step 3.
Select the name of the port group that you added in Step 7.
Step 11 On the Search Ports page, select the display name of the first voice messaging port that you created for this phone system integration.
Note By default, the display names for the voice messaging ports are composed of the port group display name followed by incrementing numbers. Step 12 On the Port Basics page, set the voice messaging port settings as applicable. The fields in the following table are the ones that you can change. Step 13 Select Save. Step 14 Select Next. Step 15 Repeat Step 12 through Step 14 for all remaining voice messaging ports for the phone system. Step 16 If another phone system integration exists, in Cisco Unity Connection Administration, expand Telephony Integrations, then select Trunk. Otherwise, skip to Step 20. Step 17 On the Search Phone System Trunks page, on the Phone System Trunk menu, select New Phone System Trunk. Step 18 On the New Phone System Trunk page, enter the following settings for the phone system trunk and select Save. Step 19 Repeat Step 17 and Step 18 for all remaining phone system trunks that you want to create. Step 20 In the Related Links drop-down list, select Check Telephony Configuration and select Go to confirm the phone system integration settings. If the test is not successful, the Task Execution Results displays one or more messages with troubleshooting steps. After correcting the problems, test the Unity Connection again.
Step 21 In the Task Execution Results window, select Close.
Testing the Integration
To test whether Cisco Unity Connection and the phone system are integrated correctly, do the following procedures in the order listed.
If any of the steps indicate a failure, see the following documentation as applicable:
Troubleshooting Guide for Cisco Unity Connection Release 11.x, available at https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/11x/troubleshooting/guide/b_11xcuctsg.html
Setting Up the Test Configuration
Procedure
Testing an External Call with Release Transfer
Procedure
Step 1 From Phone 2, enter the access code necessary to get an outside line, then enter the number outside callers use to dial directly to Unity Connection. Step 2 In the Port Monitor, note which port handles this call. Step 3 When you hear the opening greeting, enter the extension for Phone 1. Hearing the opening greeting means that the port is configured correctly. Step 4 Confirm that Phone 1 rings and that you hear a ringback tone on Phone 2. Hearing a ringback tone means that Unity Connection correctly released the call and transferred it to Phone 1. Step 5 Leaving Phone 1 unanswered, confirm that the state of the port handling the call changes to “Idle.” This state means that release transfer is successful. Step 6 Confirm that, after the number of rings that the phone system is set to wait, the call is forwarded to Unity Connection and that you hear the greeting for the test user. Hearing the greeting means that the phone system forwarded the unanswered call and the call-forward information to Unity Connection, which correctly interpreted the information. Step 7 On the Port Monitor, note which port handles this call. Step 8 Leave a message for the test user and hang up Phone 2. Step 9 In the Port Monitor, confirm that the state of the port handling the call changes to “Idle.” This state means that the port was successfully released when the call ended. Step 10 Confirm that the MWI on Phone 1 is activated. The activated MWI means that the phone system and Cisco Unity Connection are successfully integrated for turning on MWIs.
Testing Listening to Messages
Procedure
Step 1 From Phone 1, enter the internal pilot number for Unity Connection. Step 2 When asked for your password, enter the password for the test user. Hearing the request for your password means that the phone system sent the necessary call information to Cisco Unity Connection, which correctly interpreted the information. Step 3 Confirm that you hear the recorded name for the test user (if you did not record a name for the test user, you will hear the extension number for Phone 1). Hearing the recorded name means that Cisco Unity Connection correctly identified the user by the extension. Step 4 Listen to the message. Step 5 After listening to the message, delete the message. Step 6 Confirm that the MWI on Phone 1 is deactivated. The deactivated MWI means that the phone system and Unity Connection are successfully integrated for turning off MWIs. Step 7 Hang up Phone 1. Step 8 On the Port Monitor, confirm that the state of the port handling the call changes to “Idle.” This state means that the port was successfully released when the call ended.
Setting Up Supervised Transfer on Unity Connection
Procedure
Step 1 In Cisco Unity Connection Administration, on the Edit Transfer Rule page for the test user, in the Transfer Type field, select Supervise Transfer. Step 2 In the Rings to Wait For field, enter 3. Step 3 Select Save. Step 4 Minimize the Cisco Unity Connection Administration window. Do not close the Cisco Unity Connection Administration window because you will use it again in a later procedure.
Testing Supervised Transfer
Procedure
Step 1 From Phone 2, enter the access code necessary to get an outside line, then enter the number outside callers use to dial directly to Unity Connection. Step 2 On the Port Monitor, note which port handles this call. Step 3 When you hear the opening greeting, enter the extension for Phone 1. Hearing the opening greeting means that the port is configured correctly. Step 4 Confirm that Phone 1 rings and that you do not hear a ringback tone on Phone 2. Instead, you should hear the indication your phone system uses to mean that the call is on hold (for example, music). Step 5 Leaving Phone 1 unanswered, confirm that the state of the port handling the call remains “Busy.” This state and hearing an indication that you are on hold mean that Unity Connection is supervising the transfer. Step 6 Confirm that, after three rings, you hear the greeting for the test user. Hearing the greeting means that Unity Connection successfully recalled the supervised-transfer call. Step 7 During the greeting, hang up Phone 2. Step 8 On the Port Monitor, confirm that the state of the port handling the call changes to “Idle.” This state means that the port was successfully released when the call ended. Step 9 Select Stop Polling. Step 10 Sign out of RTMT.
Adding New User Templates for Multiple Integrations
When you create the first phone system integration, this phone system is automatically selected in the default user template. The users that you add after creating this phone system integration will be assigned to this phone system by default.
However, for each additional phone system integration that you create, you must add the applicable new user templates that will assign users to the new phone system. You must add the new templates before you add new users who will be assigned to the new phone system.
For details on adding new user templates, or on selecting a user template when adding a new user, see the “User Templates” section in “User Attributes” chapter of the System Administration Guide for Cisco Unity Connection Release 11.x. The guide is available at
https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/11x/administration/guide/b_cucsag.html
Compatibility of Phone System Components
Testing has shown compatibility of the following phone system components with Cisco Unity Connection in a SIP integration.
Table 8 Cisco SIP Proxy Server Compatibility with the Integration If Cisco Unity Connection authenticates with the SIP proxy server, the authentication name entered in Cisco Unity Connection must be the same as the contact line name in the SIP proxy server.
If Cisco Unity Connection authenticates with the SIP proxy server, the authentication name entered in Cisco Unity Connection must be the same as the contact line name in the SIP proxy server.
Table 9 Cisco 7960 IP Phone Compatibility with the Integration When the phone initiates a call, release transfer of the call is not available to Cisco Unity Connection.
When the phone initiates a call, release transfer of the call is not available to Cisco Unity Connection.
Table 10 Pingtel xpressa Compatibility with the Integration To get the call forwarding to busy greeting integration feature, forwarding must be programmed on the SIP proxy server rather than configured on the Pingtel xpressa phones.
Not compatible. Silence is inserted into the audio stream every few seconds.
To get the call forwarding to busy greeting integration feature, forwarding must be programmed on the SIP proxy server rather than configured on the Pingtel xpressa phones.
Other compatibility issues are:
The Pingtel xpressa cannot connect to a backup SIP proxy server.
To enable call forwarding when Cisco Unity Connection is configured for failover, set the forwarding destinations in MySQL to be <contact line name>@proxy instead of <contact line name>@Unity Connection.
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)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Copyright © 2015, Cisco Systems, Inc. All rights reserved.