Cisco Unified Communications Manager Express SCCP Integration Guide for Cisco Unity Release 5.0
Setting Up a Cisco Unified CallManager Express SCCP Integration with Cisco Unity
Downloads: This chapterpdf (PDF - 258.0KB) The complete bookPDF (PDF - 927.0KB) | Feedback

Setting Up a Cisco Unified Communications Manager Express SCCP Integration with Cisco Unity

Table Of Contents

Setting Up a Cisco Unified Communications Manager Express SCCP Integration with Cisco Unity

Task List to Create the Integration by SCCP

Requirements

Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity

Programming a Single Cisco Unified Communications Manager Express Router to Integrate with a Single Cisco Unity Server

Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with a Single Cisco Unity Server

Creating a New Integration with Cisco Unified Communications Manager Express


Setting Up a Cisco Unified Communications Manager Express SCCP Integration with Cisco Unity


For detailed instructions for setting up a Cisco Unified Communications Manager Express SCCP integration with Cisco Unity, see the following sections in this chapter:

Task List to Create the Integration by SCCP

Requirements

Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity

Creating a New Integration with Cisco Unified Communications Manager Express


Note Cisco Unity failover is not available with the Cisco Unified CM Express integration.

AMIS Networking and call loop detection will not function when Cisco Unity is integrated with Cisco Unified CM Express.

The G.729a codec is not supported.


Cisco Unity can integrate with Cisco Unified CM Express in SRST mode. For details, see the Integrating Cisco Unity with Cisco Unified CME-as-SRST application note at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_installation_and_configuration_guides_list.html.

Task List to Create the Integration by SCCP

Before doing the following tasks to integrate Cisco Unity with Cisco Unified CM Express by Skinny Call Control Protocol (SCCP), confirm that the Cisco Unity server is ready for the integration by completing the applicable tasks in the applicable Cisco Unity installation guide. 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 Chapter 2, "Planning How the Voice Messaging Ports Will Be Used by Cisco Unity."

3. Program Cisco Unified CM Express. See the "Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity" section.

4. Create the integration. See the "Creating a New Integration with Cisco Unified Communications Manager Express" section.

5. Test the integration. See Chapter 4, "Testing the Integration."

Requirements

The Cisco Unified Communications Manager Express SCCP integration supports configurations of the following components:

Phone System

Cisco Unified CM Express.

For details on compatible versions of Cisco Unified CM Express, 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/sw/voicesw/ps2237/products_device_support_tables_list.html.

The following phones or combinations of phones for the Cisco Unified CM extensions:

Only SCCP phones for the Cisco Unified CM Express extensions.

Both SCCP phones and SIP phones for the Cisco Unified CM Express extensions.

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.

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_guides_list.html.

Cisco Unified CM Express feature license.

Cisco IP phone feature licenses, and Cisco licenses for other H.323-compliant devices or software (such as Cisco VirtualPhone and Microsoft NetMeeting clients) that will be connected to the network, as well as one license for each Cisco Unity port.

Analog phones connected to ATA. (For integration limitations with these phones, see Chapter 1, "Introduction.")

A LAN connection in each location where you will plug an IP phone into the network.

Cisco Unity Server

The applicable version of Cisco Unity. For details on compatible versions of Cisco Unity, 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/sw/voicesw/ps2237/products_device_support_tables_list.html.

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 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/sw/voicesw/ps2237/products_device_support_tables_list.html.

A license that enables the appropriate number of voice messaging ports.

Centralized Voice Messaging

Cisco Unity supports centralized voice messaging by supporting various inter-phone system networking protocols including, for example, proprietary protocols such as Avaya DCS, Nortel MCDN, or Siemens CorNet, and standards-based protocols such as QSIG or DPNSS. For details, see the "Centralized Voice Messaging" section in the "Integrating Cisco Unity with the Phone System" chapter of the Design Guide for Cisco Unity Release 5.x at http://www.cisco.com/en/US/docs/voice_ip_comm/unity/5x/design/guide/5xcudgx.html.

Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity

After the Cisco Unified Communications Manager Express router is installed, do the procedures in the applicable section depending on the number of Cisco Unified CM Express routers that you will integrate with the Cisco Unity 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 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 Server" section.

Programming a Single Cisco Unified Communications Manager 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 CM Express router with a single Cisco Unity server. If you are integrating multiple Cisco Unified CM Express routers, see the "Programming Multiple Cisco Unified Communications Manager 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 CM 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:

telephony-service
 voicemail 4001

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 applicable command:

For ephone-dns that will be used by ports that are dedicated for leaving and retrieving voice messages, enter the following command:

ephone-dn <DN tag> dual-line

For ephone-dns that will be used only to dial out, enter 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 dial out by Cisco Unity (for example, use "A01").


Step 3 To set the display name for the port (for example, "Voice Messaging System" or "Dial Out Only"), enter the following command:

name <Display name of voice messaging port>

Step 4 To set the device name for the port (for example, "CU-VI1" or "CU-Dialout1"), enter the following command:

description <Device name of voice messaging port>

Step 5 To reserve the second ephone-dn channel for supervised transfers, enter the following command:

huntstop channel

Step 6 To set the dial-peer preference for the extension, enter the following command:

preference <Preference order>

Step 7 Enter the applicable command:

To disable huntstop, enter the following command:

no huntstop

To enable huntstop, enter the following command:

huntstop

Step 8 Repeat Step 1 through Step 7 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 9 To exit the ephone-dn configuration mode, enter the following command:

exit


The following is an example of the configuration:

ephone-dn 32 dual-line
 number 4001
 name "Voice Messaging System"
 description "CU-VI1"
 huntstop channel
 no huntstop
 preference 1
!
ephone-dn 33 dual-line
 number 4001
 name "Voice Messaging System"
 description "CU-VI2"
 huntstop channel
 no huntstop
 preference 2
!
ephone-dn 34 dual-line
 number 4001
 name "Voice Messaging System"
 description "CU-VI3"
 huntstop channel
 huntstop
 preference 3
!
ephone-dn 35
 number A01
 name "Dial Out Only"
 description "CU-Dialout1"

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. These three ephone-dns are also configured with two channels each (the second channel is reserved for supervised transfers). The fourth ephone-dn is provided for use as a dial-out port. The first three ephone-dns are configured with the same extension number (4001), using preferences 1, 2, and 3 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 dial out by Cisco Unity (for example, to set MWIs). Separate ports are required for answering calls and dialing out in order to prevent call-collision problems between incoming calls placed by Cisco Unified CM Express to Cisco Unity, and outgoing calls that Cisco Unity places in the opposite direction.

To Associate the Voice Messaging Port

To associate the actual voice messaging port (vm-device-id) to the phone number, associate the Cisco IP phone with the voice messaging port.

The vm-device-id name uses the following format:

<Cisco Unity device name prefix><Port number>

The vm-device-id name must match the Cisco Unity voice messaging port name that 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, CU-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 messaging port to the Cisco Unified CM 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 CU-VI, enter CU-VI1 for the first port, CU-VI2 for the second port, and so on.


Caution The vm-device-id name used by Cisco Unified CM 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 names.


Note The number of voice messaging port 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.

ephone 5
 vm-device-id CU-VI1
 button 1:32
!
ephone 6
 vm-device-id CU-VI2
 button 1:33
!
ephone 7
 vm-device-id CU-VI3
 button 1:34
!
ephone 8
 vm-device-id CU-VI4
 button 1:35

To Configure a Directory Number for MWI Notification

MWI configuration on the Cisco Unified CM 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.

ephone-dn 32
 number 8000 secondary 8001
 mwi on-off

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 to the "Creating a New Integration with Cisco Unified Communications Manager Express" section.


Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with a Single Cisco Unity Server

A single, centralized Cisco Unity server can be used by multiple Cisco Unified CM Express routers. This configuration requires that one Cisco Unified CM Express router be on the same LAN as the Cisco Unity server, and that this Cisco Unified CM Express router register all Cisco Unity voice messaging ports. This Cisco Unified CM Express router (the SIP MWI server) is a proxy server that relays SIP MWI messages between the Cisco Unity server and all other Cisco Unified CM Express routers (the SIP MWI clients). Note that Cisco Unity voice messaging ports register with only the SIP MWI server (the Cisco Unified CM 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 CM Express routers with a single Cisco Unity server.

To Configure the Message Button Access to Cisco Unity


Step 1 On the Cisco Unified CM 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:

telephony-service
 voicemail 4001

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 applicable command:

For ephone-dns that will be used by ports that are dedicated for leaving and retrieving voice messages, enter the following command:

ephone-dn <DN tag> dual-line

For ephone-dns that will be used only to dial out, enter 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 dial out by Cisco Unity (for example, use "A01").


Step 3 To set the display name for the port (for example, "Voice Messaging System" or "Dial Out Only"), enter the following command:

name <Display name of voice messaging port>

Step 4 To set the device name for the port (for example, "CU-VI1" or "CU-Dialout1"), enter the following command:

description <Device name of voice messaging port>

Step 5 To reserve the second ephone-dn channel for supervised transfers, enter the following command:

huntstop channel

Step 6 To set the dial-peer preference for the extension, enter the following command:

preference <Preference order>

Step 7 Enter the applicable command:

To disable huntstop, enter the following command:

no huntstop

To enable huntstop, enter the following command:

huntstop

Step 8 Repeat Step 1 through Step 7 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 9 To exit the ephone-dn configuration mode, enter the following command:

exit


The following is an example of the configuration:

ephone-dn 32 dual-line
 number 4001
 name "Voice Messaging System"
 description "CU-VI1"
 huntstop channel
 no huntstop
 preference 1
!
ephone-dn 33 dual-line
 number 4001
 name "Voice Messaging System"
 description "CU-VI2"
 huntstop channel
 no huntstop
 preference 2
!
ephone-dn 34 dual-line
 number 4001
 name "Voice Messaging System"
 description "CU-VI3"
 huntstop channel
 huntstop
 preference 3
!
ephone-dn 35
 number A01
 name "MWI Only"
 description "CU-Dialout1"

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. These three ephone-dns are also configured with two channels each (the second channel is reserved for supervised transfers). The fourth ephone-dn is provided for use as a dial-out port. The first three ephone-dns are configured with the same extension number (4001), using preferences 1, 2, and 3 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 dial out by Cisco Unity. Separate ports are required for answering calls and dialing out in order to prevent call-collision problems between incoming calls placed by Cisco Unified CM Express to Cisco Unity, and outgoing calls that Cisco Unity places in the opposite direction.

To Associate the Voice Messaging Port

To associate the actual voice messaging port (vm-device-id) to the phone number, associate the Cisco IP phone with the voice messaging port.

The vm-device-id name uses the following format:

<Cisco Unity device name prefix><Port number>

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 messaging port with the Cisco Unified CM 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 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 CU-VI, enter CU-VI1 for the first port, CU-VI2 for the second port, and so on.


Caution The vm-device-id name used by Cisco Unified CM 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 names.


Note The number of voice messaging port 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.

ephone 5
 vm-device-id CU-VI1
 button 1:32
!
ephone 6
 vm-device-id CU-VI2
 button 1:33
!
ephone 7
 vm-device-id CU-VI3
 button 1:34
!
ephone 8
 vm-device-id CU-VI4
 button 1:35

Do the following procedure.

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. 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 CM 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 device 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 CM Express to receive MWIs from a SIP MWI server by entering the following command:

mwi sip

This command integrates the Cisco Unified CM 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 CM 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.

ephone-dn 32
 number 8000 secondary 8001
 mwi on-off

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.

To Configure MWI Relay

MWI relay is required when Cisco Unity is integrated with multiple Cisco Unified CM Express routers. The Cisco Unified CM Express routers use the SIP subscriber and notifier mechanism for MWI relay. The Cisco Unified CM Express router that is the SIP MWI relay server acts as the SIP notifier. The other Cisco Unified CM 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 CM Express router to relay MWI information to Cisco IP phones on other Cisco Unified CM 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 CM 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


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 CM 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 CM Express router integrated with Cisco Unity (the dial-peer must have a session target of the Cisco Unified CM Express router, not Cisco Unity), enter the following command:

dtmf-relay h245-signal

Step 2 Create a destination pattern that matches the Cisco Unified CM 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 CM Express routers integrated with Cisco Unity.


Creating a New Integration with Cisco Unified Communications Manager Express

After ensuring that Cisco Unified Communications Manager Express and Cisco Unity 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 SCCP (CUCM/CCM and CUCME/CCME only) and click Next.

Step 5 On the Name CUCM/CCM Integration and Cluster page, enter the following settings, then click Next.

Table 3-1 Settings for the CUCM/CCM Integration and Cluster Page 

Field
Setting

Integration Name

Enter the name you will use to identify this Cisco Unified CM Express integration. Accept the default name or enter another name.

Cluster Name

Enter the name you will use to identify this Cisco Unified CM Express phone system. Accept the default name or enter another name.


Step 6 On the Enter CUCM/CCM IP Address and Port page, enter the following settings, then click Next.

Table 3-2 Settings for the Enter CUCM/CCCP IP Address and Port Page 

Field
Setting

IP Address/Name

Enter the IP address (or DNS name) of the Cisco Unified CM Express router that matches the IP source address entered by the ip source-address command on the Cisco Unified CM Express router.

TCP Port

Enter the TCP port of the Cisco Unified CM Express router that matches the TCP port entered by the ip source-address command on the Cisco Unified CM Express router. The default port is 2000.


You can click Ping Server to confirm that the IP address is correct.

Step 7 On the Enter Secondary Server Settings for Failover page, click Next.

Step 8 On the Enter CUCM/CCM MWI Extensions page, enter the following settings, then click Next.

Table 3-3 Settings for the Enter CUCM/CCM MWI Extensions Page 

Field
Setting

MWI On Extension

Enter the MWI on directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express phone system.

MWI Off Extension

Enter the MWI off directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express phone system.


Step 9 On the Set Number of Voice Messaging Ports page, enter the following settings, then click Next.

Table 3-4 Settings for the Set Number of Voice Messaging Ports Page 

Field
Setting

Number of Ports

Enter the number of voice messaging ports connecting Cisco Unity to the Cisco Unified CM Express router. This number cannot be more than the number of ports set up on the Cisco Unified CM Express router. 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.

CUCM/CCM Device Name Prefix

Enter the prefix that Cisco Unified CM Express uses in the vm-device-id name before the port number. This prefix must match the prefix used by Cisco Unified CM Express.


You can click Verify to confirm that the CUCM/CCM device name prefix is correct.

Step 10 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 11 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 12.

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 3-5 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 12 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 13.

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 3-6 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 13 On the Completing page, verify the settings you entered, then click Finish.

Step 14 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 CUCM/CCM Security Mode field is set to Non-Secure.

Step 5 Click the Ports tab.

Step 6 Enter the settings shown in Table 3-7 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. This arrangement helps minimize 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.


Caution In programming the Cisco Unified CM Express router, 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.

Table 3-7 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

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.


Step 7 Click Save.


To Identify the Phone System to Cisco Unity as Cisco Unified CM Express


Step 1 In the right pane of the UTIM window, click the Servers tab.

Step 2 Under IP Address or Host Name, click the IP address or host name of the Cisco Unified CM Express router.

Step 3 Click Modify.

Step 4 In the Modify Server dialog box, in the IP Address or Host Name field, enter the IP address or host name for the Cisco Unified CM Express router.

Step 5 Check the This Server Is CUCME/CCME check box and click OK.

Step 6 In the UTIM window, click Save.

Step 7 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.

Step 8 Exit UTIM.


To Adjust the Advanced Settings for 72 or More Voice Messaging Ports


Step 1 On the Cisco Unity server, on the Windows Start menu, click Programs > Cisco Unity > Cisco Unity Tools Depot.

Step 2 In the Tools Depot window, in the left pane, expand Administration Tools and double-click Advanced Settings Tool.

Step 3 If the Cisco Unity server is running Windows Server 2003, do the following substeps. Otherwise, continue to Step 4.

a. In the Cisco Unity Advanced Settings window, in the left pane, click Messaging - 72 or More Voice Ports - Enable Low-Fragmentation Heap.

b. In the New Value drop-down box, click 1 and click Set.

c. When prompted that the value has been set, click OK.

Step 4 If Exchange is the message store, do the following substeps. Otherwise, continue to Step 5.

a. In the Cisco Unity Advanced Settings window, in the left pane, click Messaging - 72 or More Voice Ports - Number of MAPI Sessions Per Exchange Server.

b. In the New Value drop-down box, click the applicable setting, then click Set.

Number of Voice Messaging Ports
Setting

72 to 83

Click 2.

84 to 95

Click 3.

96 to 119

Click 4.

120 to 143

Click 5.

144

Click 6.


c. When prompted that the value has been set, click OK.

Step 5 Close the Tools Depot window.

Step 6 Restart the Cisco Unity server.