Table Of Contents
Setting Up a Cisco Unified Communications Manager Express SIP Trunk Integration with Cisco Unity Connection
Integration Tasks
Requirements
Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity Connection
Creating a New Integration with Cisco Unified Communications Manager Express
Setting Up a Cisco Unified Communications Manager Express SIP Trunk Integration with Cisco Unity Connection
For detailed instructions for setting up a Cisco Unified Communications Manager Express SIP trunk integration with Cisco Unity Connection, see the following sections in this chapter:
•
Integration Tasks
•
Requirements
•
Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity Connection
•
Creating a New Integration with Cisco Unified Communications Manager Express
This document does not apply to the configuration in which Cisco Unity Connection is installed as Cisco Unified Communications Manager Business Edition (CMBE)—on the same server with Cisco Unified Communications Manager.
Note
Cisco Unified Communications Manager Express does not support Keypad Markup Language (KPML) for sending DTMF keystrokes in a SIP message (out-of-band).
Integration Tasks
Before doing the following tasks to integrate Cisco Unity Connection with Cisco Unified CM Express through a SIP trunk, confirm that the Cisco Unity Connection server is ready for the integration by completing the applicable tasks in the Installation Guide for Cisco Unity Connection.
1.
Review the system and equipment requirements to confirm that all phone system and Cisco Unity Connection server requirements have been met. See the "Requirements" section.
2.
Plan how the voice messaging ports will be used by Cisco Unity Connection. See Chapter 2, "Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection."
3.
Program Cisco Unified CM Express. See the "Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity Connection" section.
4.
Create the integration. See the "Creating a New Integration with Cisco Unified Communications Manager Express" section.
5.
Test the integration. See Chapter 4, "Testing the Integration."
6.
If this integration is a second or subsequent integration, add the applicable new user templates for the new phone system. See Chapter 5, "Adding New User Template for Multiple Integrations."
Requirements
The Cisco Unified CM Express SIP integration supports configurations of the following components:
Phone System
•
A compatible version of Cisco Unified CM Express.
For details on compatible versions of Cisco Unified CM Express, refer to the SIP Trunk Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.
•
A compatible Cisco IOS software version. Refer to the Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/prod_installation_guide09186a00805acf50.html.
•
Cisco Unified CM Express feature license.
•
Cisco IP phone feature licenses, and Cisco licenses for other H.323-compliant devices or software (such as Cisco VirtualPhone and Microsoft NetMeeting clients) that will be connected to the network, as well as one license for each Cisco Unity Connection port.
•
For the Cisco Unified CM Express extensions, SIP phones that support DTMF relay as described in RFC-2833. For a list of supported Cisco IP phone models, refer to the applicable Supported Firmware, Platforms, Memory, and Voice Products document at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/prod_installation_guides_list.html.
•
For the Cisco Unified CM Express extensions, one of the following configurations:
–
Only SIP phones.
–
Both SCCP phones and SIP phones.
Note that older SCCP phone models may require a Media Termination Point (MTP) to function correctly.
•
A LAN connection in each location where you will plug the applicable phone into the network.
Cisco Unity Connection Server
•
The applicable version of Cisco Unity Connection. For details on compatible versions of Cisco Unity Connection, refer to the SIP Trunk Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.
•
Cisco Unity Connection installed and ready for the integration, as described in the Installation Guide for Cisco Unity Connection at http://www.cisco.com/en/US/products/ps6509/prod_installation_guides_list.html.
•
A license that enables the applicable number of voice messaging ports.
Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity Connection
Revised December 11, 2008
For details on programming the Cisco Unified Communications Manager Express router for the integration with Cisco Unity Connection, refer to the "Integrating Voice Mail" chapter of the Cisco Unified Communications Manager Express System Administrator Guide at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_installation_and_configuration_guides_list.html.
After you have configured the Cisco Unified CM Express router for the integration, do the applicable following procedures:
•
For Cisco Unified CM Express 4.1 or later, if calls can be received from a Cisco Unified Communications Manager SIP trunk, do the "To Configure the Cisco Unified Communications Manager Express Router When It is Connected to a Cisco Unified Communications Manager SIP Trunk (Cisco Unified Communications Manager Express 4.1 or Later)" procedure.
•
For a Cisco Unity Connection cluster, do the "To Configure the Cisco Unified Communications Manager Express Router for a Cisco Unity Connection Cluster" procedure.
To Configure the Cisco Unified Communications Manager Express Router When It is Connected to a Cisco Unified Communications Manager SIP Trunk (Cisco Unified Communications Manager Express 4.1 or Later)
Step 1
On the Cisco Unified CM Express router, go into the global configuration mode by entering the following command:
configure terminal
Step 2
To enter the voice service configuration mode, enter the following command:
voice service voip
Step 3
To disable the 302 "Moved Temporarily" SIP message, enter the following command:
no supplementary-service sip moved-temporarily
Step 4
To exit the global configuration mode, enter the following command:
exit
To Configure the Cisco Unified Communications Manager Express Router for a Cisco Unity Connection Cluster
Step 1
On the Cisco Unified CM Express router, go into the global configuration mode by entering the following command:
configure terminal
Step 2
To enter dial-peer configuration mode for port group for the publisher server, enter the following command:
dial-peer voice <number> voip
Step 3
To set the description for the dial-peer, enter the following command:
description <name of publisher server>
Step 4
To set the Cisco Unity Connection pilot number for the dial-peer, enter the following command:
destination-pattern <pilot number>
Step 5
To configure the dial-peer to use Session Initiation Protocol (SIP) for calls, enter the following command:
session protocol sipv2
Step 6
To specify the IP address (or DNS name) of the publisher server, enter the following command:
session target {ipv4:<IP address>|dns:<host name>}
Step 7
To enable DTMF relay, enter the following command:
dtmf-relay rtp-nte
Step 8
To set the codec for calls, enter the following command:
codec <codec used for calls>
Step 9
To equalize the number of calls sent to each Cisco Unity Connection server in the Connection cluster, enter the following command:
max-conn <number of ports handled by publisher server>
Step 10
To set the dial-peer preference for port group so that the calls will be routed first to the subscriber server, then to the publisher server if no ports are available on the subscriber server, enter the following command:
preference 2
Step 11
To enable huntstop, enter the following command:
huntstop
Step 12
To exit the global configuration mode, enter the following command:
exit
Step 13
To set a dial-peer that will prevent Cisco Unified CM Express from hunting beyond the dial-peers for the Cisco Unity Connection port groups, entering the following command:
configure terminal
Step 14
To enter dial-peer configuration mode, enter the following command:
dial-peer voice <number> voip
Step 15
To set the description for the dial-peer, enter the following command:
description <name of subscriber server>
Step 16
To set the Cisco Unity Connection pilot number for the dial-peer, enter the following command:
destination-pattern <pilot number>
Step 17
To configure the dial-peer to use Session Initiation Protocol (SIP) for calls, enter the following command:
session protocol sipv2
Step 18
To specify the IP address (or DNS name) of the subscriber server, enter the following command:
session target {ipv4:<IP address>|dns:<host name>}
Step 19
To enable DTMF relay, enter the following command:
dtmf-relay rtp-nte
Step 20
To set the codec for calls, enter the following command:
codec <codec used for calls>
Step 21
To equalize the number of calls sent to each Cisco Unity Connection server in the Connection cluster, enter the following command:
max-conn <number of ports handled by subscriber server>
Step 22
To set the dial-peer preference so that the calls will be routed first to the subscriber server, then to the publisher server if no ports are available on the subscriber server, enter the following command:
preference 1
Step 23
To disable huntstop so that the calls will use the next available voice messaging port on the subscriber server, then use voice messaging ports on the publisher server if no ports are available on the subscriber server, enter the following command:
no huntstop
Step 24
To exit the global configuration mode, enter the following command:
exit
The following is an example of the configuration without a Cisco Unity Connection cluster:
session target ipv4:<IP address>
The following is an example of the configuration with a Cisco Unity Connection cluster configured:
destination-pattern <pilot number>
session target ipv4:<IP address of publisher server>
destination-pattern <pilot number>
session target ipv4:<IP address of subscriber server>
Creating a New Integration with Cisco Unified Communications Manager Express
After ensuring that Cisco Unified Communications Manager Express and Cisco Unity Connection are ready for the integration, do the following procedure to set up the integration and to enter the port settings.
To Create an Integration
Step 1
Log on to Cisco Unity Connection Administration.
Step 2
In Cisco Unity Connection Administration, expand Telephony Integrations, then click Phone System.
Step 3
On the Search Phone Systems page, under Display Name, click the name of the default phone system.
Step 4
On the Phone System Basics page, in the Phone System Name field, enter the descriptive name that you want for the phone system.
Step 5
If you want to use this phone system for TRaP connections (when users record and playback through the phone in Cisco Unity Connection web applications), check the Default TRAP Switch check box. If you want to use another phone system for TRaP connections, uncheck this check box.
Step 6
Click Save.
Step 7
On the Phone System Basics page, in the Related Links drop-down box, click Add Port Group and click Go.
Step 8
On the New Port Group page, enter the applicable settings and click Save.
Table 3-1 Settings for the New Port Group Page
Field
|
Setting
|
Phone System
|
Click the name of the phone system that you entered in Step 4.
|
Create From
|
Click Port Group Template and click SIP in the drop-down box.
|
Display Name
|
Enter a descriptive name for the port group. You can accept the default name or enter the name that you want.
|
Authenticate with SIP Server
|
Check this check box if you want Cisco Unity Connection to authenticate with the Cisco Unified CM Express router.
|
Authentication User Name
|
Enter the name that Cisco Unity Connection will use to authenticate with the Cisco Unified CM Express router.
|
Authentication Password
|
Enter the password that Cisco Unity Connection will use to authenticate with the Cisco Unified CM Express router.
|
Contact Line Name
|
Enter the voice messaging line name (or pilot number) that users will use to contact Cisco Unity Connection and that Cisco Unity Connection will use to register with the Cisco Unified CM Express router.
|
SIP Security Profile
|
Click the SIP security profile that Cisco Unity Connection will use.
Note Cisco Unified CM Express does not support Cisco Unified CM authentication and encryption.
|
SIP Transport Protocol
|
Click the SIP transport protocol that Cisco Unity Connection will use.
|
IP Address or Host Name
|
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
|
Port
|
Enter the IP port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
|
Step 9
On the Port Group Basics page, in the Related Links drop-down box, click Add Ports and click Go.
Step 10
On the New Port page, enter the following settings and click Save.
Table 3-2 Settings for the New Port Page
Field
|
Setting
|
Enabled
|
Check this check box.
|
Number of Ports
|
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.
|
Phone System
|
Click the name of the phone system that you entered in Step 4.
|
Port Group
|
Click the name of the port group that you added in Step 8.
|
Server Name
|
Click the name Cisco Unity Connection server.
|
Step 11
On the Search Ports page, click 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.
Table 3-3 Settings for the Voice Messaging Ports
Field
|
Considerations
|
Enabled
|
Check this check box to enable the port. The port is enabled during normal operation.
Uncheck this check box to disable the port. When the port is disabled, calls to the port get a ringing tone but are not answered. Typically, the port is disabled only by the installer during testing.
|
Server Name
|
(For Cisco Unity Connection clusters only) Click the name of the Cisco Unity Connection server that you want to handle this port.
Assign an equal number of answering and dial-out voice messaging ports to the Cisco Unity Connection servers so that they equally share the voice messaging traffic.
|
Answer Calls
|
Check this check box to designate the port for answering calls. These calls can be incoming calls from unidentified callers or from users.
|
Perform Message Notification
|
Check this check box to designate the port for notifying users of messages. Assign Perform Message Notification to the least busy ports.
|
Send MWI Requests
|
Check this check box to designate the port for turning MWIs on and off. Assign Send MWI Requests to the least busy ports.
|
Allow TRAP Connections
|
Check this check box so that users can use the port for recording and playback through the phone in Cisco Unity Connection web applications. Assign Allow TRAP Connections to the least busy ports.
|
Step 13
Click Save.
Step 14
Click 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 click Trunk. Otherwise, skip to Step 20.
Step 17
On the Search Phone System Trunks page, on the Phone System Trunk menu, click New Phone System Trunk.
Step 18
On the New Phone System Trunk page, enter the following settings for the phone system trunk and click Save.
Table 3-4 Settings for the Phone System Trunk
Field
|
Setting
|
From Phone System
|
Click the display name of the phone system that you are creating a trunk for.
|
To Phone System
|
Click the display name of the previously existing phone system that the trunk will connect to.
|
Trunk Access Code
|
Enter the extra digits that Cisco Unity Connection must dial to transfer calls through the gateway to extensions on the previously existing phone system.
|
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, click Check Telephony Configuration and click 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 connection again.
Step 21
In the Task Execution Results window, click Close.