Table Of Contents
Cisco Unified Commuications Manager Express 4.1 SCCP Integration Guide for Cisco Unity Connection 1.2
Integration Tasks
Task List to Create the Integration
Task List to Change the Number of Voice Messaging Ports
Requirements
Integration Description
Call Information
Integration Functionality
Integrations with Multiple Phone Systems
Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection
Programming the Cisco Unified CM Express Phone System
Programming a Single Cisco Unified Communications Manager Express Router to Integrate with a Single Cisco Unity Connection Server
Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with a Single Cisco Unity Connection Server
Creating a New Integration with the Cisco Unified Communications Manager Express Phone System
Testing the Integration
(Multiple Integrations Only) Adding New User Templates
Changing the Number of Voice Messaging Ports
Appendix: Documentation and Technical Assistance
Conventions
Obtaining Documentation, Obtaining Support, and Security Guidelines
Cisco Unified Commuications Manager Express 4.1 SCCP Integration Guide for Cisco Unity Connection 1.2
Published March 21, 2007
This document provides instructions for integrating Cisco Unified Communications Manager (CM) Express (formerly known as Cisco Unified CallManager Express) with Cisco Unity Connection by Skinny Call Control Protocol (SCCP).
Cisco Unity Connection supports an SCCP integration when the Cisco Unified CM Express phone system has only SCCP phones or has both SCCP and SIP phones.
Note 
The G.729a codec is not supported.
Integration Tasks
Before doing the following tasks to integrate Cisco Unity Connection with the Cisco Unified Communications Manager Express phone system, confirm that the Cisco Unity Connection server is ready for the integration by completing the applicable tasks in the Cisco Unity installation guide.
The following task lists describe the process for creating an integration and changing the number of voice messaging ports.
Task List to Create the Integration
Use the following task list to set up a new integration with the Cisco Unified Communications Manager Express phone system. If you are installing a new Cisco Unity Connection server by using the Cisco Unity installation guide, you may have already completed some of the following tasks.
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 the "Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection" section.
3. Program Cisco Unified Communications Manager Express. See the "Programming the Cisco Unified CM Express Phone System" section.
4. Create the integration. See the "Creating a New Integration with the Cisco Unified Communications Manager Express Phone System" section.
Note An additional Cisco Unified CM cluster can be added by creating a new phone system integration through the Phone System Integration Wizard. Each Cisco Unified CM cluster is a separate phone system integration.
5. Test the integration. See the "Testing the Integration" section.
6. If this integration is a second or subsequent integration, add the applicable new user templates for the new phone system. See the (Multiple Integrations Only) Adding New User Templates.
Task List to Change the Number of Voice Messaging Ports
Use the following task list to change the number of voice messaging ports for an integration after it has been created.
1. Change the number of voice messaging ports in Cisco Unified CM Express and in Cisco Unity Connection Administration. See the "Changing the Number of Voice Messaging Ports" section.
Requirements
The Cisco Unified Communications Manager Express integration supports configurations of the following components:
Phone System
•Cisco Unified Communications Manager Express 4.1.
•A compatible Cisco IOS software version. Refer to the Cisco Unified Communications Manager Express and Cisco IOS Software Version Compatibility Matrix at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/prod_installation_guide09186a00805acf50.html.
•Cisco Unified Communications Manager 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 a list of supported Cisco IP phone models, refer to the Specifications document for the applicable version of Cisco Unified CM Express at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_documentation_roadmap09186a0080189132.html.
•Analog phones connected to ATA. (For integration limitations with these phones, see the "Integration Functionality" section.)
•A LAN connection in each location where you will plug an IP 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 SCCP Compatibility Matrix: Cisco Unity, the Cisco Unity-CM TSP, 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 Cisco Unity installation guide at http://www.cisco.com/en/US/products/ps6509/prod_installation_guides_list.html.
•The applicable Cisco Unity-CM TSP, installed. For details on compatible versions of the TSP, refer to the SCCP Compatibility Matrix: Cisco Unity, the Cisco Unity-CM TSP, 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 license that enables the appropriate number of voice messaging ports.
Integration Description
The Cisco Unified Communications Manager Express integration uses the LAN to connect Cisco Unity Connection and the phone system. The Cisco Unified Communications Manager Express also provides connections to the PSTN. Figure 1 shows the connections for a system with a single Cisco Unified Communications Manager Express router.
Figure 1 Connections Between the Phone System and Cisco Unity Connection
Figure 2 shows the connections for a system with multiple Cisco Unified Communications Manager Express routers and a single Cisco Unity Connection server. One Cisco Unified Communications Manager Express router acts as the SIP MWI server, and the remaining Cisco Unified Communications Manager Express routers act as SIP MWI clients. Note that Cisco Unity Connection voice messaging ports register with only the SIP MWI server (the Cisco Unified Communications Manager Express router that is on the same LAN as the Cisco Unity Connection server), not with the SIP MWI clients.
Figure 2 Connections Between Multiple Cisco Unified Communications Manager Express Routers and a Single Cisco Unity Connection Server
Call Information
The phone system sends the following information with forwarded calls:
•The extension of the called party
•The extension of the calling party (for internal calls) or the phone number of the calling party (if it is an external call and the system uses caller ID)
•The reason for the forward (the extension is busy, does not answer, or is set to forward all calls)
Cisco Unity Connection uses this information to answer the call appropriately. For example, a call forwarded to Cisco Unity Connection is answered with the personal greeting of the user. If the phone system routes the call to Cisco Unity Connection without this information, Cisco Unity Connection answers with the opening greeting.
Integration Functionality
The Cisco Unified Communications Manager Express integration with Cisco Unity Connection provides the following features:
•Call forward to personal greeting
•Call forward to busy greeting
•Caller ID
•Easy message access (a subscriber can retrieve messages without entering an ID because Cisco Unity Connection identifies the subscriber based on the extension from which the call originated; a password may be required)
•Identified subscriber messaging (Cisco Unity Connection identifies the subscriber who leaves a message during a forwarded internal call, based on the extension from which the call originated)
•Message waiting indication (MWI)
These integration features are not available to analog phones connected through FXS ports on the Cisco Unified Communications Manager Express phone system. Analog phones connected to ATA, however, support all integration features, except MWIs (MWI lamps will not light, though the stutter dial tone will sound).
Integrations with Multiple Phone Systems
Cisco Unity Connection can be integrated with multiple phone systems at one time. For information on and instructions for integrating Cisco Unity Connection with multiple phone systems, refer to the Multiple Phone System Integration Guide at http://www.cisco.com/en/US/products/ps6509/products_installation_and_configuration_guides_list.html.
Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection
Before programming the phone system, you need to plan how the voice messaging ports will be used by Cisco Unity Connection. The following considerations will affect the programming for the phone system (for example, setting up the hunt group or call forwarding for the voice messaging ports):
•The number of voice messaging ports installed.
•The number of voice messaging ports that will answer calls.
•The number of voice messaging ports that will 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 Cisco Unity Connection that can be set on Telephony Integrations > Port of Cisco Unity Administrator.
Table 1 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.
|
Extension
|
Enter the extension for the port as assigned on the phone system.
|
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.
|
Outgoing Hunt Order
|
Enter the priority order in which Cisco Unity Connection will use the ports when dialing out (for example, if the Perform Message Notification, Send MWI Requests, or Allow TRAP Connections check box is checked). The highest numbers are used first. However, when multiple ports have the same Outgoing Hunt Order number, Cisco Unity Connection will use the port that has been idle the longest.
|
The Number of Voice Messaging Ports to Install
The number of voice messaging ports to install depends on numerous factors, including:
•The number of calls Cisco Unity Connection will answer when call traffic is at its peak.
•The expected length of each message that callers will record and that users will listen to.
•The number of users.
•The number of ports that will be set to dial out only.
•The number of calls made for message notification.
•The number of MWIs that will be 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 will use the automated attendant and call handlers when call traffic is at its peak.
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.
The Number of Voice Messaging Ports That Will Answer Calls
The calls that the voice messaging ports answer can be incoming calls from unidentified callers or from users. Typically, the voice messaging ports that answer calls are the busiest.
You can set voice messaging ports to both answer calls and to dial out (for example, to send message notifications). However, when the voice messaging ports perform more than one function and are very active (for example, answering many calls), the other functions may be delayed until the voice messaging port is free (for example, message notifications cannot be sent until there are fewer calls to answer). For best performance, dedicate certain voice messaging ports for only answering incoming calls, and dedicate other ports for only dialing out. Separating these port functions eliminates the possibility of a collision, in which an incoming call arrives on a port at the same time that Cisco Unity Connection takes the port off-hook to dial out.
The Number of Voice Messaging Ports That Will Only Dial Out, and Not Answer Calls
Ports that will only dial out and will not answer calls can do one or more of the following:
•Notify users by phone, pager, or e-mail of messages that have arrived.
•Turn MWIs on and off for user extensions.
•Make a TRAP connection so that users can use the phone as a recording and playback device in Cisco Unity Connection web applications.
Typically, these voice messaging ports are the least busy ports.
Caution In programming the phone system, do not send calls to voice messaging ports in Cisco Unity Connection that cannot answer calls (voice messaging ports that are not set to Answer Calls). For example, if a voice messaging port is set only to Send MWI Requests, do not send calls to it.
Preparing for Programming the Phone System
Record your decisions about the voice messaging ports to guide you in programming the phone system.
Programming the Cisco Unified CM Express Phone System
After the Cisco Unified Communications Manager Express router is installed, do the procedures in the applicable section depending on the number of Cisco Unified Communications Manager Express routers you will integrate with the Cisco Unity Connection server:
•Single Cisco Unified Communications Manager Express router—see the "Programming a Single Cisco Unified Communications Manager Express Router to Integrate with a Single Cisco Unity Connection Server" section
•Multiple Cisco Unified Communications Manager Express routers—see the "Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with a Single Cisco Unity Connection Server" section
Programming a Single Cisco Unified Communications Manager Express Router to Integrate with a Single Cisco Unity Connection Server
Note Do the procedures in this section only if you are integrating a single Cisco Unified Communications Manager Express router with a single Cisco Unity Connection server. If you are integrating multiple Cisco Unified Communications Manager Express routers, see the "Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with a Single Cisco Unity Connection Server" section.
To Configure the Message Button Access to Cisco Unity Connection
This procedure configures the Message button on Cisco IP phones to dial the Cisco Unity Connection pilot number when pressed.
Step 1 On the Cisco Unified Communications Manager Express router, go into the telephony-service configuration mode by entering the following command:
telephony-service
Step 2 Enter the following command:
voicemail <Cisco Unity Connection pilot number>
Step 3 To exit the telephony-service configuration mode, enter the following command:
exit
The following is an example of the configuration:
To Configure the Router for Cisco Unity Connection
Step 1 Go into the ephone-dn configuration mode and configure the directory number tag for the Cisco IP phone lines by entering the following command:
ephone-dn <DN tag>
Step 2 To set the extension number for the voice messaging port, enter the following command:
number <voice messaging port extension>
Note The voice message port extension must be the Cisco Unity Connection pilot number (configured by the "voicemail" command in the preceding procedure) for all ports dedicated for leaving and retrieving voice messages. Use an extension that cannot be dialed for all ports that are used to set MWIs by Cisco Unity Connection (for example, use "A01").
Step 3 To set the user name for the port (for example, "Voice Port 1" or "MWI Only"), enter the following command:
name <user name of voice messaging port>
Step 4 To disable huntstop, enter the following command:
no huntstop
Step 5 To set the dial-peer preference for the extension, enter the following command:
preference <preference order>
Step 6 Repeat Step 1 through Step 5 for all remaining ports.
Note The number of voice messaging ports set up to connect to Cisco Unity Connection must be the same as the number of directory number tags for the Cisco IP phone lines set up by the ephone-dn configuration mode.
Step 7 To exit the ephone-dn configuration mode, enter the following command:
exit
The following is an example of the configuration:
name "Voice Messaging Port 1"
name "Voice Messaging Port 2"
name "Voice Messaging Port 3"
In this example, there are four ephone-dns configured to provide four voice messaging ports. Three of the ephone-dns are configured with the same extension number to provide ports dedicated for leaving and retrieving voice messages. The fourth ephone-dn is provided for use as an MWI-only port. The first three ephone-dns are configured with the same extension number (4001), using preferences 0, 1, and 2 to create a hunt group. If the first port is busy, the call goes to the second port, and so on. Port 4 is configured with the extension number A01 and is used to set MWIs by Cisco Unity Connection. Separate ports are required for answering calls and setting MWIs in order to prevent call-collision problems between incoming calls placed by Cisco Unified Communications Manager Express to Cisco Unity Connection, and MWI calls that Cisco Unity Connection places in the opposite direction.
To Associate the Voice Messaging Port Device
To associate the actual voice messaging port device (vm-device-id) to the phone number, associate the Cisco IP phone with the voice messaging port device.
The vm-device-id name uses the following format:
<Cisco Unity Connection device name prefix><Port number>
The default vm-device-id name is CiscoUM-VI1. The vm-device-id name must match the Cisco Unity Connection voice messaging port name you will use to identify the port in Cisco Unity Administrator when you create the integration:
•The Cisco Unity Connection device name prefix part (for example, CiscoUM-VI) must match the Device Name Prefix field on Telephony Integrations > Port Group > Port Group Basics page of Cisco Unity Administrator.
•The port number part (for example, "1") must match the number part of the Cisco Unity Administrator voice messaging port name used to identify the port on the Telephony Integrations > Port > Port Basics page of Cisco Unity Administrator.
To associate a voice mail device to the Cisco Unified Communications Manager Express router, do the following steps, beginning in ephone configuration mode.
Step 1 Go into the ephone configuration mode and register the Cisco IP phones by entering the following command:
ephone <DN tag>
Step 2 Define the voice messaging port device name, by entering the following command:
vm-device-id <Cisco Unity Connection device name prefix><port number>
For example, if the Cisco Unity Connection device name prefix is CiscoUM-VI, enter CiscoUM-VI1 for the first port and CiscoUM-VI2 for the second port, and so on.
Note The vm-device-id name used by Cisco Unified Communications Manager Express must be the same as the voice messaging port name used by Cisco Unity Connection. Otherwise, the integration will not work.
Step 3 Assign buttons to the Cisco IP phone directory numbers created in the "To Configure the Router for Cisco Unity Connection" procedure by entering the following command:
button <button number>:<DN tag>
For example, you can use the values 1:1, 2:4, or 3:14. In this example, button 1 corresponds to directory number 1 (ephone-dn 1), button 2 corresponds to directory number 4, and button 3 corresponds to directory number 14. The buttons correspond to the phone lines on the Cisco IP phone.
Step 4 Repeat Step 1 through Step 3 for all remaining voice messaging port device names.
Note The number of voice messaging port device names configured with the vm-device-id command must be the same as the number of Cisco IP phones registered by the ephone configuration mode.
Step 5 To exit the ephone configuration mode, enter the following command:
exit
Following is an example of the configuration. In this example, the vm-device-id command is used within the ephone configuration in place of the mac-address parameter that is used for configuring a regular Cisco IP phone.
To Configure a Directory Number for MWI Notification
MWI configuration on the Cisco Unified Communications Manager Express is performed by dedicating Cisco IP phone directory numbers (ephone-DNs) to process MWI status notification calls originating from Cisco Unity Connection. You must allocate a minimum of one MWI processing ephone-dn for each MWI ephone-dn voice messaging port. The MWI processing ephone-dn extensions are configured to match the MWI extensions configured on Cisco Unity Connection.
Step 1 Go into the ephone-dn configuration mode and configure the directory numbers for the Cisco IP phone lines by entering the following command:
ephone-dn <DN tag>
Step 2 Configure two valid directory numbers for the Cisco IP phone to be used for MWIs—the first number will turn MWIs on, and the second number will turn MWIs off—by entering the following command:
number <MWI on number> secondary <MWI off number>
Note The MWI on and off numbers must match the settings of the MWI On Extension and MWI Off Extension fields you enter in Cisco Unity Connection when you create the integration.
Step 3 Configure these two directory numbers to be used for setting MWIs by entering the following command:
mwi on-off
Step 4 To exit the ephone-dn configuration mode, enter the following command:
exit
Following is an example of the configuration.
number 8000 secondary 8001
In this example, Cisco Unity Connection calls extensions 8000 and 8001 to turn MWIs on and off. The DN triggers an MWI ON event when 8000 is called, and an MWI OFF event when 8001 is called.
For extensions associated with analog telephone adaptors (ATAs), the MWI is a lit function button on the ATA and a stutter dial tone on the connected analog phone.
Note After completing the procedures in this section, continue with the "Creating a New Integration with the Cisco Unified Communications Manager Express Phone System" section.
Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with a Single Cisco Unity Connection Server
A single, centralized Cisco Unity Connection server can be used by multiple Cisco Unified Communications Manager Express routers. This configuration requires that one Cisco Unified Communications Manager Express router be on the same LAN as the Cisco Unity Connection server, and that this Cisco Unified Communications Manager Express router register all Cisco Unity Connection voice messaging ports. This Cisco Unified Communications Manager Express router (the SIP MWI server) is a proxy server that relays SIP MWI messages between the Cisco Unity Connection and all other Cisco Unified Communications Manager Express routers (the SIP MWI clients). Note that Cisco Unity Connection voice messaging ports register with only the SIP MWI server (the Cisco Unified Communications Manager Express router that is on the same LAN as the Cisco Unity Connection server), not with the SIP MWI clients.
Do the procedures in this section only if you are integrating multiple Cisco Unified Communications Manager Express routers with a single Cisco Unity Connection server.
To Configure the Message Button Access to Cisco Unity Connection
This procedure configures the Message button on Cisco IP phones to dial the Cisco Unity Connection pilot number when pressed.
Step 1 On the Cisco Unified Communications Manager Express router, go into the telephony-service configuration mode by entering the following command:
telephony-service
Step 2 Enter the following command:
voicemail <Cisco Unity Connection pilot number>
Step 3 To exit the telephony-service configuration mode, enter the following command:
exit
The following is an example of the configuration:
To Configure the Router for Cisco Unity Connection
Step 1 Go into the ephone-dn configuration mode and configure the directory number tag for the Cisco IP phone lines by entering the following command:
ephone-dn <DN tag>
Step 2 To set the extension number for the voice messaging port, enter the following command:
number <voice messaging port extension>
Note The voice message port extension must be the Cisco Unity Connection pilot number (configured by the "voicemail" command in the preceding procedure) for all ports dedicated for leaving and retrieving voice messages. Use an extension that cannot be dialed for all ports that are used to set MWIs by Cisco Unity Connection (for example, use "A01").
Step 3 To set the user name for the port (for example, "Voice Port 1" or "MWI Only"), enter the following command:
name <user name of voice messaging port>
Step 4 To disable huntstop, enter the following command:
no huntstop
Step 5 To set the dial-peer preference for the extension, enter the following command:
preference <preference order>
Step 6 Repeat Step 1 through Step 5 for all remaining ports.
Note The number of voice messaging ports set up to connect to Cisco Unity Connection must be the same as the number of directory number tags for the Cisco IP phone lines set up by the ephone-dn configuration mode.
Step 7 To exit the ephone-dn configuration mode, enter the following command:
exit
The following is an example of the configuration:
name "Voice Messaging Port 1"
name "Voice Messaging Port 2"
name "Voice Messaging Port 3"
In this example, there are four ephone-dns configured to provide four voice messaging ports. Three of the ephone-dns are configured with the same extension number to provide ports dedicated for leaving and retrieving voice messages. The fourth ephone-dn is provided for use as an MWI-only port. The first three ephone-dns are configured with the same extension number (4001), using preferences 0, 1, and 2 to create a hunt group. If the first port is busy, the call goes to the second port, and so on. Port 4 is configured with the extension number A01 and is used to set MWIs by Cisco Unity Connection. Separate ports are required for answering calls and setting MWIs in order to prevent call-collision problems between incoming calls placed by Cisco Unified Communications Manager Express to Cisco Unity Connection, and MWI calls that Cisco Unity Connection places in the opposite direction.
To Associate the Voice Messaging Port Device
To associate the actual voice messaging port device (vm-device-id) to the phone number, associate the Cisco IP phone with the voice messaging port device.
The vm-device-id name uses the following format:
<Cisco Unity Connection device name prefix><Port number>
The default vm-device-id name is CiscoUM-VI1. The vm-device-id name must match the Cisco Unity Connection voice messaging port name you will use to identify the port in Cisco Unity Administrator when you create the integration:
•The Cisco Unity Connection device name prefix part (for example, CiscoUM-VI) must match the Device Name Prefix field on the Telephony Integrations > Port Group page.
•The port number part (for example, "1") must match the number part of the Cisco Unity Connection voice messaging port name used to identify the port on the Telephony Integrations > Port page.
To associate a voice mail device with the Cisco Unified Communications Manager Express router, do the following steps, beginning in ephone configuration mode.
Step 1 Go into the ephone configuration mode and register the Cisco IP phones by entering the following command:
ephone <DN tag>
Step 2 Define the voice messaging port device name, by entering the following command:
vm-device-id <Cisco Unity Connection device name prefix><Port number>
For example, if the Cisco Unity Connection device name prefix is CiscoUM-VI, enter CiscoUM-VI1 for the first port and CiscoUM-VI2 for the second port, and so on.
Note The vm-device-id name used by Cisco Unified Communications Manager Express must be the same as the voice messaging port name used by Cisco Unity Connection. Otherwise, the integration will not work.
Step 3 Assign buttons to the Cisco IP phone directory numbers created in the "To Configure the Router for Cisco Unity Connection" procedure by entering the following command:
button <Button number>:<DN tag>
For example, you can use the values 1:1, 2:4, or 3:14. In this example, button 1 corresponds to directory number 1 (ephone-dn 1), button 2 corresponds to directory number 4, and button 3 corresponds to directory number 14. The buttons correspond to the phone lines on the Cisco IP phone.
Step 4 Repeat Step 1 through Step 3 for all remaining voice messaging port device names.
Note The number of voice messaging port device names configured with the vm-device-id command must be the same as the number of Cisco IP phones registered by the ephone configuration mode.
Step 5 To exit the ephone configuration mode, enter the following command:
exit
Following is an example of the configuration. In this example, the vm-device-id command is used within the ephone configuration in place of the mac-address parameter that is used for configuring a regular Cisco IP phone.
To Configure the SIP MWI Server
Step 1 Go into the SIP user-agent configuration mode by entering the following command:
sip-ua
Step 2 Configure the IP address (or DNS name) and port for the SIP MWI server by entering the following command:
mwi-server {ipv4:<MWI server IP address> | dns:<MWI server host-name} [expires <Seconds>]
[port <Port number>] [transport {tcp | udp}] [unsolicited]
The SIP MWI server must be in the same LAN as Cisco Unity Connection. This IP address is used in conjunction with the "mwi sip" command in ephone-dn configuration mode to subscribe individual ephone-dn extension numbers to the MWI server notification list. The SIP MWI client runs TCP by default.
This command uses the following keywords:
•ipv4:—Sets the IP address of the SIP MWI server.
•dns:—Sets the DNS name of the SIP MWI server.
•expires—(optional) Subscription expiration time, in seconds. The range is 1 to 999999. The default is 3600.
•transport tcp—The default setting.
•transport udp—Allows you to integrate with the SIP MWI client.
•port—Used to specify the TCP port for the SIP MWI server. The default SIP port number is 5060.
•unsolicited—Allows sending SIP NOTIFY for MWIs without the need to send a SUBSCRIBE from the Cisco Unified Communications Manager Express router.
Step 3 To exit the SIP user-agent configuration mode, enter the following command:
exit
Step 4 Go into the telephony-service configuration mode by entering the following command:
telephony-service
Step 5 If you want to keep the default registration with an extension number, continue to Step 6. If you want to register with an E.164 10-digit number, enter the following command:
mwi reg-e164
Step 6 To exit the telephony-service configuration mode, enter the following command:
exit
Step 7 Continue to the next procedure.
To Configure MWIs for Each Directory Number
Step 1 Go into the ephone-dn configuration mode and configure the directory numbers for the Cisco IP phone lines by entering the following command:
ephone-dn <DN tag>
Step 2 Configure a valid directory number for the Cisco IP phone that receives the MWI notification by entering the following command:
number <directory number>
Step 3 Configure the user name of MWI for the directory number that receives MWI notification by entering the following command:
name MWI
Step 4 Subscribe the extension in a Cisco Unified Communications Manager Express to receive MWIs from a SIP MWI server by entering the following command:
mwi sip
This command integrates the Cisco Unified Communications Manager Express with the MWI service based on SIP protocol.
Note The "mwi sip-server" command under telephony-service configuration mode or the "mwi-server" command under SIP user-agent configuration mode must be set before enabling the "mwi sip" command in ephone configuration mode.
Step 5 To exit the ephone-dn configuration mode, enter the following command:
exit
To Configure a Directory Number for MWI Notification
MWI configuration on the Cisco Unified Communications Manager Express is performed by dedicating Cisco IP phone directory numbers (ephone-DNs) to process MWI status notification calls originating from Cisco Unity Connection. You must allocate a minimum of one MWI processing ephone-dn for each MWI ephone-dn voice messaging port. The MWI processing ephone-dn extensions are configured to match the MWI extensions configured on Cisco Unity Connection.
Step 1 Go into the ephone-dn configuration mode and configure the directory numbers for the Cisco IP phone lines by entering the following command:
ephone-dn <DN tag>
Step 2 Configure two valid directory numbers for the Cisco IP phone to be used for MWIs—the first number will turn MWIs on, and the second number will turn MWIs off—by entering the following command:
number <MWI on number> secondary <MWI off number>
Note The MWI on and off numbers must match the settings of the MWI On Extension and MWI Off Extension fields you enter in Cisco Unity Administrator when you create the integration on Cisco Unity Connection.
Step 3 Configure these two directory numbers to be used for setting MWIs by entering the following command:
mwi on-off
Step 4 To exit the ephone-dn configuration mode, enter the following command:
exit
Following is an example of the configuration.
number 8000 secondary 8001
In this example, Cisco Unity Connection calls extensions 8000 and 8001 to turn MWIs on and off. The DN triggers an MWI ON event when 8000 is called, and an MWI OFF event when 8001 is called.
To Configure MWI Relay
MWI relay is required when Cisco Unity Connection is integrated with multiple Cisco Unified Communications Manager Express routers. The Cisco Unified Communications Manager Express routers use the SIP subscriber and notifier mechanism for MWI relay. The Cisco Unified Communications Manager Express router that is the SIP MWI relay server acts as the SIP notifier. The other Cisco Unified Communications Manager Express routers (the SIP MWI clients) act as the SIP subscribers.
Step 1 Go into the telephony-service configuration mode by entering the following command:
telephony-service
Step 2 Enable the Cisco Unified Communications Manager Express router to relay MWI information to Cisco IP phones on other Cisco Unified Communications Manager Express routers by entering the following command:
mwi relay
Step 3 To exit the telephony-service configuration mode, enter the following command:
exit
Step 4 Go into the SIP user-agent configuration mode by entering the following command:
sip-ua
Step 5 Configure the IP address (or DNS name) and port for the SIP MWI server by entering the following command:
mwi-server {ipv4:<MWI server IP address> | dns:<MWI server host-name} [expires <Seconds>]
[port <Port number>] [transport {tcp | udp}] [unsolicited]
The SIP MWI server must be in the same LAN as Cisco Unity Connection. This IP address is used in conjunction with the "mwi sip" command in ephone-dn configuration mode to subscribe individual ephone-dn extension numbers to the MWI server notification list. The SIP MWI client runs TCP by default.
This command uses the following keywords:
•ipv4:—Sets the IP address of the SIP MWI server.
•dns:—Sets the DNS name of the SIP MWI server.
•expires—(optional) Subscription expiration time, in seconds. The range is 1 to 999999. The default is 3600.
•transport tcp—The default setting.
•transport udp—Allows you to integrate with the SIP MWI client.
•port—Used to specify the TCP port for the SIP MWI server. The default SIP port number is 5060.
•unsolicited—Allows sending SIP NOTIFY for MWIs without the need to send a SUBSCRIBE from the Cisco Unified Communications Manager Express router.
Step 6 To exit the SIP user-agent configuration mode, enter the following command:
exit
Step 7 Go into the telephony-service configuration mode by entering the following command:
telephony-service
Step 8 If you want to keep the default registration with an extension number, continue to Step 9. If you want to register with an E.164 10-digit number, enter the following command:
mwi reg-e164
Step 9 To exit the telephony-service configuration mode, enter the following command:
exit
Step 10 Continue to the next procedure.
To Enable DTMF Relay
In certain situations, DTMF digits are not recognized when processed through VoIP dial-peer gateways. To avoid this problem, certain gateways must be configured to enable DTMF relay. The DTMF relay feature is available in Cisco IOS software version 12.0(5) and later.
Cisco IOS software-based gateways that use H.245 out-of-band signaling (but not the Cisco Unified Communications Manager Express routers with which Cisco Unity Connection is integrated) must be configured to enable DTMF relay.
The Catalyst 6000 T1/PRI and FXS gateways enable DTMF relay by default and do not need additional configuration to enable this feature.
Step 1 On a VoIP dial-peer that points to a Cisco Unified Communications Manager Express router integrated with Cisco Unity Connection (the dial-peer must have a session target of the Cisco Unified Communications Manager Express router, not Cisco Unity Connection), enter the following command:
dtmf-relay h245-signal
Step 2 Create a destination pattern that matches the Cisco Unified Communications Manager Express voice mail port numbers. For example, if the system has voice mail 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 that point to Cisco Unified Communications Manager Express routers integrated with Cisco Unity Connection.
Creating a New Integration with the Cisco Unified Communications Manager Express Phone System
After ensuring that the Cisco Unified Communications Manager Express phone system and Cisco Unity Connection are ready for the integration, do the following procedures to set up the integration and to enter the port settings.
To Create an Integration
Step 1 Log on to Cisco Unity Administrator.
Step 2 In Cisco Unity Administrator, expand Telephony Integrations, then click Phone System.
Step 3 On the Search Phone Systems page, on the Phone System menu, click New Phone System. The Phone System Integration Wizard appears.
Step 4 On the Select Phone System Manufacturer page, in the Manufacturer field, click Cisco Systems and click Next.
Step 5 On the Select Phone System Model page, in the Model field, click CallManager and click Next.
Step 6 On the Set Up Phone System page, in the Phone System Name field, accept the default name or enter the descriptive name that you want, and click Next.
Step 7 On the Select Port Group Template page, in the Port Group Template field, click SCCP - Skinny Client Control Protocol and click Next.
Step 8 On the Set Up Port Group page, enter the following settings and click Next.
Table 2 Settings for the Set Up Port Group Page
Field
|
Setting
|
Port Group Name
|
<the display name for the port group; accept the default name, which is composed of the phone system display name followed by an incrementing number, or enter another descriptive name>
|
Device Name Prefix
|
<the prefix that Cisco Unified Communications Manager Express uses in the vm-device-id name before the port number; this prefix must match the prefix used by Cisco Unified Communications Manager Express>
|
MWI On Extension
|
<the MWI on directory number that you specified in the ephone-dn configuration mode of the Cisco Unified Communications Manager Express phone system>
|
MWI Off Extension
|
<the MWI off directory number that you specified in the ephone-dn configuration mode of the Cisco Unified Communications Manager Express phone system>
|
Security Mode
|
Non-secure
(Cisco Unified CM authentication and encryption are not available for Cisco Unified Communications Manager Express.)
|
Number of Ports
|
<the number of voice messaging ports that you want to create in this port group>
|
IP Address or Host Name
|
<the IP address (or host name) of the Cisco Unified Communications Manager Express router that you are integrating with Cisco Unity Connection>
|
Test Address
|
Click this button to test the IP address that you entered. The results of the test appear in the field to the right of the button.
Note Even though the integration is successful, the test may fail on networks where the "ping" command is disabled or ignored, or when the Cisco Unified CM Express router is not running.
|
Port
|
<the TCP port of the Cisco Unified Communications Manager Express router that you are integrating with Cisco Unity Connection; we recommend that you use the default setting>
|
TLS Port
|
<the TLS port of the Cisco Unified Communications Manager Express router that you are integrating with Cisco Unity Connection; we recommend that you use the default setting>
|
Server Type
|
Cisco Unified Communications Manager Express
|
Step 9 On the Confirm Phone System Settings page, confirm the settings that you have entered and click Finish.
Step 10 On the Phone System Creation Summary page, click Close.
Step 11 In Cisco Unity Administrator, expand Telephony Integrations, then click Port Group.
Step 12 On the Search Port Groups page, click the display name of the port group that you created for the Cisco Unified Communications Manager Express integration in Step 8.
Step 13 On the Port Group Basics page, on the Edit menu, click Advanced Settings.
Step 14 On the Edit Advanced Settings page, in the Delay Before Opening Greeting field, enter 1000 and click Save.
Step 15 In Cisco Unity Administrator, expand Telephony Integrations, then click Port.
Step 16 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 17 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 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.
|
Extension
|
Enter the extension for the port as assigned on the phone system.
|
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.
|
Outgoing Hunt Order
|
Enter the priority order in which Cisco Unity Connection will use the ports when dialing out (for example, if the Perform Message Notification, Send MWI Requests, or Allow TRAP Connections check box is checked). The highest numbers are used first. However, when multiple ports have the same Outgoing Hunt Order number, Cisco Unity Connection will use the port that has been idle the longest.
|
Security Mode
|
Click Non-secure.
(Cisco Unified CM authentication and encryption are not available.)
|
Step 18 Click Save.
Step 19 Click Next.
Step 20 Repeat Step 17 through Step 19 for all remaining voice messaging ports for the phone system.
Step 21 If another phone system integration exists, in Cisco Unity Administrator, expand Telephony Integrations, then click Trunk. Otherwise, skip to Step 25.
Step 22 On the Search Phone System Trunks page, on the Phone System Trunk menu, click New Phone System Trunk.
Step 23 On the New Phone System Trunk page, enter the following settings for the phone system trunk and click Save.
Table 4 Settings for the Phone System Trunk
Field
|
Setting
|
From Phone System
|
<the display name of the phone system that you are creating a trunk for>
|
To Phone System
|
<the display name of the previously existing phone system that the trunk will connect to>
|
Trunk Access Code
|
<the extra digits that Cisco Unity Connection must dial to transfer calls through the gateway to extensions on the previously existing phone system>
|
Step 24 Repeat Step 22 and Step 23 for all remaining phone system trunks that you want to create.
Step 25 If prompted to restart Cisco Unity Connection, in the Windows task bar, right-click the Cisco Unity Connection icon and click Restart > Voice Processing Server Role.
Step 26 When prompted to confirm stopping the Voice Processing server role, click Yes.
Step 27 In Cisco Unity Administrator, 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 28 In the Task Execution Results window, click Close.
Step 29 Log off Cisco Unity Administrator.
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, refer to the following documentation as applicable:
•The installation guide for the phone system.
•The setup information earlier in this guide.
To Set Up the Test Configuration
Step 1 Set up two test extensions (Phone 1 and Phone 2) on the same phone system that Cisco Unity Connection is connected to.
Step 2 Set Phone 1 to forward calls to the Cisco Unity Connection pilot number when calls are not answered.
Caution The phone system must forward calls to the Cisco Unity Connection pilot number in no fewer than four rings. Otherwise, the test may fail.
Step 3 To create a test user for testing, in Cisco Unity Administrator, expand Users, then click Users.
Step 4 On the Search Users page, on the User menu, click New User.
Step 5 On the New User page, enter the following settings.
Table 5 Settings for the New User Page
Field
|
Setting
|
User Type
|
User with Voice Mailbox
|
Based on Template
|
<the applicable user template>
|
Alias
|
testuser
|
First Name
|
Test
|
Last Name
|
User
|
Display Name
|
Test User
|
Extension
|
<the extension of Phone 1>
|
Step 6 Click Save.
Step 7 On the Edit User Basics page, in the Voice Name field, record a voice name for the test user.
Step 8 In the Phone System field, confirm that the phone system selected is the phone system that Phone 1 is connected to.
Step 9 Uncheck the Set for Self-enrollment at Next Login check box.
Step 10 Click Save.
Step 11 On the Edit menu, click Message Waiting Indicators.
Step 12 On the Message Waiting Indicators page, click the message waiting indicator. If no message waiting indication is in the table, click Add New.
Step 13 On the Edit Message Waiting Indicator page, enter the following settings.
Table 6 Settings for the Edit MWI Page
Field
|
Setting
|
Enabled
|
Check this check box to enable MWIs for the test user.
|
Display Name
|
Accept the default or enter a different name.
|
Inherit User's Extension
|
Check this check box to enable MWIs on Phone 1.
|
Step 14 Click Save.
Step 15 On the Edit menu, click Transfer Options.
Step 16 On the Transfer Options page, click the active option.
Step 17 On the Edit Transfer Option page, under Transfer Action, click the Extension option and enter the extension of Phone 1.
Step 18 In the Transfer Type field, click Release to Switch.
Step 19 Click Save.
Step 20 Minimize the Cisco Unity Administrator window.
Do not close the Cisco Unity Administrator window because you will use it again in a later procedure.
Step 21 On the Cisco Unity Connection desktop, double-click the Tools Depot icon.
Step 22 In the left pane of the Tools Depot window, expand Switch Integration Tools, then double-click Port Status Monitor. The Port Status Monitor window appears.
Step 23 On the Ports menu, click Start All, and arrange the port monitors so that you can notice which port will handle the calls that you will make.
To Test an External Call with Release Transfer
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 Cisco Unity Connection.
Step 2 In
