Table Of Contents
Cisco Unifed CallManager Express 3.x Integration Guide for Cisco Unity 4.0
Integration Tasks
Task List to Create the Integration
Task List to Make Changes to an Integration
Task List to Change the Number of Voice Messaging Ports
Task List to Delete an Existing Integration
Requirements
Integration Description
Call Information
Integration Functionality
Integrations with Multiple Phone Systems
Planning How the Voice Messaging Ports Will Be Used by Cisco Unity
Preparing for Programming the Phone System
Programming the Cisco Unified CallManager Express Phone System
Programming a Single Cisco Unified CallManager Express Router to Integrate with a Single Cisco Unity Server
Programming Multiple Cisco Unified CallManager Express Routers to Integrate with a Single Cisco Unity Server
Creating a New Integration with the Cisco Unified CallManager Express Phone System (SCCP)
Testing the Integration
Changing the Settings for an Existing Integration
Changing the Number of Voice Messaging Ports
Deleting an Existing Integration
Appendix: Using Alternate Extensions and MWIs
Alternate Extensions
Setting Up Alternate Extensions
Alternate MWIs
Setting Up Alternate MWIs
Appendix: Documentation and Technical Assistance
Conventions
Obtaining Documentation
Cisco.com
Product Documentation DVD
Ordering Documentation
Documentation Feedback
Cisco Product Security Overview
Reporting Security Problems in Cisco Products
Obtaining Technical Assistance
Cisco Technical Support & Documentation Website
Submitting a Service Request
Definitions of Service Request Severity
Obtaining Additional Publications and Information
Cisco Unifed CallManager Express 3.x Integration Guide for Cisco Unity 4.0
Revised March 6, 2006
This document provides instructions for integrating the Cisco Unified CallManager Express phone system with Cisco Unity.
Note 
Cisco Unity failover is not available with the Cisco Unified CallManager Express integration.
AMIS Networking and call loop detection will not function when Cisco Unity is integrated Cisco Unified CallManager Express.
The G.729a codec is not supported.
Some versions of Cisco Unified CallManager Express are not supported. Refer to the Compatibility Matrix: Cisco Unity, the Cisco Unity-CM TSP, Cisco Unified CallManager, and Cisco Unified CallManager Express at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/cmptblty/tspmtrx.htm.
Integration Tasks
Before doing the following tasks to integrate Cisco Unity with the Cisco Unified CallManager Express phone system, confirm that the Cisco Unity server is ready for the integration by completing the applicable tasks in the applicable Cisco Unity installation guide.
The following task lists describe the process for creating, changing, and deleting integrations.
Task List to Create the Integration
Use the following task list to set up a new integration with the Cisco Unified CallManager Express phone system. If you are installing a new Cisco Unity server by using the applicable 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 server requirements have been met. See the "Requirements" section.
2. Plan how the voice messaging ports will be used by Cisco Unity. See the "Planning How the Voice Messaging Ports Will Be Used by Cisco Unity" section.
3. Program Cisco Unified CallManager Express. See the "Programming the Cisco Unified CallManager Express Phone System" section.
4. Create the integration. See the "Creating a New Integration with the Cisco Unified CallManager Express Phone System (SCCP)" section.
5. Test the integration. See the "Testing the Integration" section.
Task List to Make Changes to an Integration
Use the following task list to make changes to an integration after it has been created.
1. Start the Cisco Unity Telephony Integration Manager (UTIM). See the "Changing the Settings for an Existing Integration" section.
2. Make the changes you want to the existing integration. See the "Changing the Settings for an Existing Integration" section.
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. See the "Changing the Number of Voice Messaging Ports" section.
2. Start the Cisco Unity Telephony Integration Manager (UTIM). See the "Changing the Settings for an Existing Integration" section.
3. Configure the voice messaging ports for Cisco Unity. See the "Changing the Settings for an Existing Integration" section.
Task List to Delete an Existing Integration
Use the following task list to remove an existing integration.
1. Start the Cisco Unity Telephony Integration Manager (UTIM). See the "Deleting an Existing Integration" section.
2. Delete the existing integration. See the "Deleting an Existing Integration" section.
Requirements
The Cisco Unified CallManager Express integration supports configurations of the following components:
Phone System
•For the supported versions of Cisco Unified CallManager Express, refer to the Compatibility Matrix: Cisco Unity, the Cisco Unity-CM TSP, Cisco Unified CallManager, and Cisco Unified CallManager Express at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/cmptblty/tspmtrx.htm.
•Cisco IOS software version 12.2(15)ZJ3 or later.
•Cisco Unified CallManager 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 port.
•For a list of supported Cisco IP phone models, refer to the Specifications document for the applicable version of Cisco Unified CallManager 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 Server
•Cisco Unity installed and ready for the integration, as described in the applicable Cisco Unity installation guide at http://www.cisco.com/en/US/products/sw/voicesw/ps2237/prod_installation_guides_list.html.
•The applicable Cisco Unity-CM TSP, installed. For details on compatible versions of the TSP, refer to the Compatibility Matrix: Cisco Unity, the Cisco Unity-CM TSP, Cisco Unified CallManager, and Cisco Unified CallManager Express at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/cmptblty/tspmtrx.htm.
•A license that enables the appropriate number of voice messaging ports.
Integration Description
The Cisco Unified CallManager Express integration uses the LAN to connect Cisco Unity and the phone system. The Cisco Unified CallManager Express also provides connections to the PSTN. Figure 1 shows the connections for a system with a single Cisco Unified CallManager Express router.
Figure 1 Connections Between a Single Cisco Unified CallManager Express Router and Cisco Unity
Figure 2 shows the connections for a system with multiple Cisco Unified CallManager Express routers and a single Cisco Unity server. One Cisco Unified CallManager Express router acts as the SIP MWI server, and the remaining Cisco Unified CallManager Express routers act as SIP MWI clients. Note that Cisco Unity voice messaging ports register with only the SIP MWI server (the Cisco Unified CallManager Express router that is on the same LAN as the Cisco Unity server), not with the SIP MWI clients.
Figure 2 Connections Between Multiple Cisco Unified CallManager Express Routers and a Single Cisco Unity 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 uses this information to answer the call appropriately. For example, a call forwarded to Cisco Unity is answered with the personal greeting of the subscriber. If the phone system routes the call to Cisco Unity without this information, Cisco Unity answers with the opening greeting.
When forwarding calls to greetings, Cisco Unity uses the original redirected number, not the last redirected number. For example, when A calls B and forwards the call to C whose phone forwards to voice mail, the call will go to the voice mailbox for B.
Integration Functionality
The Cisco Unified CallManager Express integration with Cisco Unity provides the following integration 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 identifies the subscriber based on the extension from which the call originated; a password may be required)
•Identified subscriber messaging (Cisco Unity 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 CallManager 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
Depending on the version, Cisco Unity can be integrated with two or more phone systems:
•Cisco Unity 4.0 and 4.1 can be integrated with a maximum of two phone systems at one time. For information on and instructions for integrating Cisco Unity with two phone systems, refer to the Dual Phone System Integration Guide at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/integuid/multi/itmultin.htm.
•Cisco Unity 4.2 and later can be integrated with two or more phone systems at one time. For information on the maximum supported combinations and instructions for integrating Cisco Unity with multiple phone systems, refer to the Multiple Phone System Integration Guide at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/integuid/multi/multcu42.htm.
Planning How the Voice Messaging Ports Will Be Used by Cisco Unity
Before programming the phone system, you need to plan how the voice messaging ports will be used by Cisco Unity. 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), to make AMIS deliveries, and to make telephone record and playback (TRAP) connections.
Table 1 describes the voice messaging port settings in Cisco Unity that can be set in UTIM, and that are displayed as read-only text on the System > Ports page of the Cisco Unity Administrator.
Table 1 Settings for the Voice Messaging Ports
Field
|
Considerations
|
Extension
|
Enter the extension for the port as assigned on the phone system.
|
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.
|
Answer Calls
|
Check this check box to designate the port for answering calls. These calls can be incoming calls from unidentified callers or from subscribers.
|
Message Notification
|
Check this check box to designate the port for notifying subscribers of messages. Assign Message Notification to the least busy ports.
|
Dialout MWI
(not used by serial or SMDI integrations)
|
Check this check box to designate the port for turning MWIs on and off. Assign Dialout MWI to the least busy ports.
|
AMIS Delivery
(available with the AMIS licensed feature only)
|
Check this check box to designate the port for making outbound AMIS calls to deliver voice messages from Cisco Unity subscribers to users on another voice messaging system. Cisco Unity supports the Audio Messaging Interchange Specification (AMIS) protocol, which provides an analog mechanism for transferring voice messages between different voice messaging systems.
This setting affects outbound AMIS calls only. All ports are used for incoming AMIS calls.
Because the transmission of outgoing AMIS messages may tie up voice ports for long periods of time, you may want to adjust the schedule on the Network > AMIS > Schedule page so that outgoing AMIS calls are placed during closed hours or at times when Cisco Unity is not processing many calls.
|
TRAP Connection
|
Check this check box so that subscribers can use the phone as a recording and playback device in Cisco Unity web applications and e-mail clients. Assign TRAP Connection to the least busy ports.
|
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 will answer when call traffic is at its peak.
•The expected length of each message that callers will record and that subscribers will listen to.
•The number of subscribers.
•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 AMIS delivery calls.
•The number of TRAP connections needed when call traffic is at its peak. (TRAP connections are used by Cisco Unity web applications and e-mail clients 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 subscribers. 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 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 subscribers by phone, pager, or e-mail of messages that have arrived.
•Turn MWIs on and off for subscriber extensions.
•Make outbound AMIS calls to deliver voice messages from Cisco Unity subscribers to users on another voice messaging system. (This action is available only with the AMIS licensed feature.)
•Make a TRAP connection so that subscribers can use the phone as a recording and playback device in Cisco Unity web applications and e-mail clients.
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 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 Dialout MWI, 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 CallManager Express Phone System
After the Cisco Unified CallManager Express router is installed, do the procedures in the applicable section depending on the number of Cisco Unified CallManager Express routers you will integrate with the Cisco Unity server:
•Single Cisco Unified CallManager Express router—see the "Programming a Single Cisco Unified CallManager Express Router to Integrate with a Single Cisco Unity Server" section
•Multiple Cisco Unified CallManager Express routers—see the "Programming Multiple Cisco Unified CallManager Express Routers to Integrate with a Single Cisco Unity Server" section
Programming a Single Cisco Unified CallManager Express Router to Integrate with a Single Cisco Unity Server
Note Do the procedures in this section only if you are integrating a single Cisco Unified CallManager Express router with a single Cisco Unity server. If you are integrating multiple Cisco Unified CallManager Express routers, see the "Programming Multiple Cisco Unified CallManager Express Routers to Integrate with a Single Cisco Unity Server" section.
To Configure the Message Button Access to Cisco Unity
This procedure configures the Message button on Cisco IP phones to dial the Cisco Unity pilot number when pressed.
Step 1 On the Cisco Unified CallManager 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 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
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 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 (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 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. Separate ports are required for answering calls and setting MWIs in order to prevent call-collision problems between incoming calls placed by Cisco Unified CallManager Express to Cisco Unity, and MWI calls that Cisco Unity 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 device name prefix><Port number>
The default vm-device-id name is CiscoUM-VI1. The vm-device-id name must match the Cisco Unity voice messaging port name you will use to identify the port in the Cisco Unity Telephony Integration Manager (UTIM) when you create the integration:
•The Cisco Unity device name prefix part (for example, CiscoUM-VI) must match the Device Name Prefix field in UTIM.
•The port number part (for example, "1") must match the number part of the Cisco Unity voice messaging port name used to identify the port in UTIM.
To associate a voice mail device to the Cisco Unified CallManager 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 device name prefix><Port number>
For example, if the Cisco Unity 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 CallManager Express must be the same as the voice messaging port name used by Cisco Unity. 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" 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 CallManager Express is performed by dedicating Cisco IP phone directory numbers (ephone-DNs) to process MWI status notification calls originating from Cisco Unity. 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.
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 UTIM 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 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 CallManager Express Phone System (SCCP)" section.
Programming Multiple Cisco Unified CallManager Express Routers to Integrate with a Single Cisco Unity Server
A single, centralized Cisco Unity server can be used by multiple Cisco Unified CallManager Express routers. This configuration requires that one Cisco Unified CallManager Express router be on the same LAN as the Cisco Unity server, and that this Cisco Unified CallManager Express router register all Cisco Unity voice messaging ports. This Cisco Unified CallManager Express router (the SIP MWI server) is a proxy server that relays SIP MWI messages between the Cisco Unity and all other Cisco Unified CallManager Express routers (the SIP MWI clients). Note that Cisco Unity voice messaging ports register with only the SIP MWI server (the Cisco Unified CallManager Express router that is on the same LAN as the Cisco Unity server), not with the SIP MWI clients.
Do the procedures in this section only if you are integrating multiple Cisco Unified CallManager Express routers with a single Cisco Unity server.
To Configure the Message Button Access to Cisco Unity
Step 1 On the Cisco Unified CallManager 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 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
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 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 (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 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. Separate ports are required for answering calls and setting MWIs in order to prevent call-collision problems between incoming calls placed by Cisco Unified CallManager Express to Cisco Unity, and MWI calls that Cisco Unity 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 device name prefix><Port number>
The default vm-device-id name is CiscoUM-VI1. The vm-device-id name must match the Cisco Unity voice messaging port name you will use to identify the port in the Cisco Unity Telephony Integration Manager (UTIM) when you create the integration:
•The Cisco Unity device name prefix part (for example, CiscoUM-VI) must match the Device Name Prefix field in UTIM.
•The port number part (for example, "1") must match the number part of the Cisco Unity voice messaging port name used to identify the port in UTIM.
To associate a voice mail device with the Cisco Unified CallManager 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 device name prefix><Port number>
For example, if the Cisco Unity 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 CallManager Express must be the same as the voice messaging port name used by Cisco Unity. 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" 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.
If you are integrating with Cisco Unified CallManager Express 3.3 or later, skip to the "To Configure the SIP MWI Server for Cisco Unified CallManager Express 3.3 and Later" procedure.
If you are integrating with Cisco Unified CallManager Express 3.2 or earlier, do the following procedure.
To Configure the SIP MWI Server for Cisco Unified CallManager Express 3.2 and Earlier
Step 1 Go into the telephony-service configuration mode by entering the following command:
telephony-service
Step 2 Configure the IP address and port for the SIP MWI server by entering the following command:
mwi sip-server <MWI server IP address>
[[transport tcp | transport udp] | [port <Port number>] | [reg-e164] [unsolicited]]
The SIP MWI server must be in the same LAN as Cisco Unity. 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:
•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.
•reg-e164—The default registration is with an extension number, so the "reg-e164" keyword allows you to register with an E.164 10-digit number.
•unsolicited—Allows sending SIP NOTIFY for MWIs without the need to send a SUBSCRIBE from the Cisco Unified CallManager Express router.
Step 3 To exit the telephony-service configuration mode, enter the following command:
exit
Step 4 Skip to the "To Configure MWIs for Each Directory Number" procedure.
If you are integrating with Cisco Unified CallManager Express 3.2 or earlier, skip to the "To Configure MWIs for Each Directory Number" procedure.
If you are integrating with Cisco Unified CallManager Express 3.3 or later, do the following procedure.
To Configure the SIP MWI Server for Cisco Unified CallManager Express 3.3 and Later
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. 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 CallManager 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 CallManager Express to receive MWIs from a SIP MWI server by entering the following command:
mwi sip
This command integrates the Cisco Unified CallManager 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 CallManager Express is performed by dedicating Cisco IP phone directory numbers (ephone-DNs) to process MWI status notification calls originating from Cisco Unity. 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.
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 UTIM when you create the integration on Cisco Unity.
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 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.
If you are integrating with Cisco Unified CallManager Express 3.3 or later, skip to the "To Configure MWI Relay for Cisco Unified CallManager Express 3.3 and Later" procedure.
If you are integrating with Cisco Unified CallManager Express 3.2 or earlier, do the following procedure.
To Configure MWI Relay for Cisco Unified CallManager Express 3.2 and Earlier
MWI relay is required when Cisco Unity is integrated with multiple Cisco Unified CallManager Express routers. The Cisco Unified CallManager Express routers use the SIP subscriber and notifier mechanism for MWI relay. The Cisco Unified CallManager Express router that is the SIP MWI relay server acts as the SIP notifier. The other Cisco Unified CallManager 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 CallManager Express router to relay MWI information to Cisco IP phones on other Cisco Unified CallManager Express routers by entering the following command:
mwi relay
Step 3 Set the expiration time, in seconds, for registration for either the client or the server by entering the following command:
mwi expires <Seconds>
The range for the number of seconds is from 600 to 99999. The default is 86400 (24 hours).
Step 4 Configure the IP address and port for a SIP MWI server by entering the following command:
mwi sip-server <SIP MWI server IP address>
[[transport tcp | transport udp] | [port <Port number>] | [reg-e164] [unsolicited]]
The SIP MWI server must be in the same LAN as Cisco Unity. This IP address is used in conjunction with the "mwi sip" command in the ephone-dn configuration mode to subscribe individual extension numbers to the SIP MWI server notification list. The SIP MWI client runs TCP by default.
This command uses the following keywords:
•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.
•reg-e164—The default registration is with an extension number, so the "reg-e164" keyword allows you to register with an E.164 10-digit number.
•unsolicited—Allows sending SIP NOTIFY for MWIs without the need to send a SUBSCRIBE from the Cisco Unified CallManager Express router.
Step 5 To exit the telephony-service configuration mode, enter the following command:
exit
Step 6 Skip to the "To Enable DTMF Relay" procedure.
If you are integrating with Cisco Unified CallManager Express 3.2 or earlier, skip to the "To Enable DTMF Relay" procedure.
If you are integrating with Cisco Unified CallManager Express 3.3 or later, do the following procedure.
To Configure MWI Relay for Cisco Unified CallManager Express 3.3 and Later
MWI relay is required when Cisco Unity is integrated with multiple Cisco Unified CallManager Express routers. The Cisco Unified CallManager Express routers use the SIP subscriber and notifier mechanism for MWI relay. The Cisco Unified CallManager Express router that is the SIP MWI relay server acts as the SIP notifier. The other Cisco Unified CallManager 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 CallManager Express router to relay MWI information to Cisco IP phones on other Cisco Unified CallManager 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. 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 CallManager 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 CallManager Express routers with which Cisco Unity 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 CallManager Express router integrated with Cisco Unity (the dial-peer must have a session target of the Cisco Unified CallManager Express server, not Cisco Unity), enter the following command:
dtmf-relay h245-signal
Step 2 Create a destination pattern that matches the Cisco Unified CallManager 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 CallManager Express routers integrated with Cisco Unity.
Creating a New Integration with the Cisco Unified CallManager Express Phone System (SCCP)
After ensuring that the Cisco Unified CallManager Express phone system and the Cisco Unity server 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 If UTIM is not already open, on the Windows Start menu of the Cisco Unity server, click Programs > Cisco Unity > Manage Integrations. UTIM appears.
Step 2 In the left pane of the UTIM window, click Cisco Unity Server.
Step 3 On the Integration menu of the UTIM window, click New. The Telephony Integration Setup Wizard appears.
Step 4 On the Welcome page, click the applicable phone system type, depending on your version of Cisco Unity:
•Cisco Unity 4.2 or later—SCCP (Cisco Unified CallManager and Cisco Unified CallManager Express only)
•Cisco Unity 4.0 or 4.1—Cisco CallManager
Step 5 Click Next.
Step 6 On the Name Cisco Unified CallManager Integration and Cluster page, enter the following settings, then click Next.
Table 2 Settings for the Name Cisco Unified CallManager Integration and Cluster Page
Field
|
Setting
|
Integration Name
|
<the name you will use to identify this Cisco Unified CallManager Express integration; accept the default name or enter another name>
|
Cluster Name
|
<the name you will use to identify this Cisco Unified CallManager Express phone system; accept the default name or enter another name>
|
Step 7 On the Enter Cisco Unified CallManager IP Address and Port page, enter the following settings, then click Next.
Table 3 Settings for the Enter Cisco Unified CallManager IP Address and Port Page
Field
|
Setting
|
IP Address/Name
|
<the IP address of the Cisco Unified CallManager Express router that matches the IP source address entered by the ip source-address command on the Cisco Unified CallManager Express router>
|
TCP Port
|
<the TCP port of the Cisco Unified CallManager Express router that matches the TCP port entered by the ip source-address command on the Cisco Unified CallManager Express router; the default port is 2000>
|
You can click Ping Server to confirm that the IP address is correct.
Step 8 On the Enter Secondary Server Settings for Failover page, click Next.
Step 9 On the Enter Cisco Unified CallManager MWI Extensions page, enter the following settings, then click Next.
Table 4 Settings for the Enter CallManager MWI Extensions Page
Field
|
Setting
|
MWI On Extension
|
<the MWI on directory number you specified in the ephone-dn configuration mode of the Cisco Unified CallManager Express phone system>
|
MWI Off Extension
|
<the MWI off directory number you specified in the ephone-dn configuration mode of the Cisco Unified CallManager Express phone system>
|
Step 10 On the Set Number of Voice Messaging Ports page, enter the following settings, then click Next.
Table 5 Settings for the Set Number of Voice Messaging Ports Page
Field
|
Setting
|
Number of Ports
|
<the number of voice messaging ports connecting Cisco Unity to the Cisco Unified CallManager Express server; this number cannot be more than the number of ports set up on Cisco Unified CallManager Express; the total number of ports used by all phone systems connected to Cisco Unity cannot be more than the number of ports enabled by the Cisco Unity license files>
|
CallManager Device Name Prefix
|
<the prefix Cisco Unified CallManager Express uses in the vm-device-id name before the port number; this prefix must match the prefix used by Cisco Unified CallManager Express>
|
You can click Verify to confirm that the CallManager device name prefix is correct.
Step 11 If other integrations already exist, the Enter Trunk Access Code page appears. Enter the extra digits that Cisco Unity must use to transfer calls through the gateway to extensions on the other phone systems with which it is integrated. Then click Next.
Step 12 (Cisco Unity 4.2 and later only) On the Reassign Subscribers page, any subscribers whose phone system integration has been deleted and who are not currently assigned to a phone system integration will appear in the list.
If no subscribers appear in the list, click Next and continue to Step 13.
Otherwise, select the subscribers that you want to assign to this phone system integration and click Next. You can use the following selection controls for selecting subscribers.
Table 6 Selection Controls for the Reassign Subscribers Page
Selection Control
|
Effect
|
Check All
|
Checks the check boxes for all subscribers in the list.
|
Uncheck All
|
Unchecks the check boxes for all subscribers in the list.
|
Toggle Selected
|
For the subscribers highlighted in the list, toggles between checking and unchecking the check boxes.
If some highlighted subscriber check boxes are checked and others are unchecked, clicking this button will check all the check boxes. Clicking again will uncheck all the check boxes.
|
Step 13 (Cisco Unity 4.2 and later only) On the Reassign Call Handlers page, any call handlers whose phone system integration has been deleted and that are not currently assigned to a phone system integration will appear in the list.
If no call handlers appear in the list, click Next and continue to Step 14.
Otherwise, select the call handlers that you want to assign to this phone system integration and click Next. You can use the following selection controls for selecting call handlers.
Table 7 Selection Controls for the Reassign Call Handlers Page
Selection Control
|
Effect
|
Check All
|
Checks the check boxes for all call handlers in the list.
|
Uncheck All
|
Unchecks the check boxes for all call handlers in the list.
|
Toggle Selected
|
For the call handlers highlighted in the list, toggles between checking and unchecking the check boxes.
If some highlighted call handler check boxes are checked and others are unchecked, clicking this button will check all the check boxes. Clicking again will uncheck all the check boxes.
|
Step 14 On the Completing page, verify the settings you entered, then click Finish.
Step 15 At the prompt to restart the Cisco Unity services, click Yes. The Cisco Unity services restart.
Alternatively, you can restart the Cisco Unity services in UTIM on the Tools menu by clicking Restart Cisco Unity.
To Enter the Voice Messaging Port Settings for the Integration
Step 1 After the Cisco Unity services restart, on the View menu, click Refresh.
Step 2 In the left pane of the UTIM window, expand the phone system integration that you are creating.
Step 3 In the left pane, click the name of the cluster.
Step 4 In the right pane, on the Servers tab, confirm that the Cisco Unified CallManager Security Mode field is set to Non-Secure.
Step 5 Click the Ports tab.
Step 6 Enter the settings shown in Table 8 for the voice messaging ports.
To get the best performance, use the first voice messaging ports for incoming calls and the last ports to dial out.
