Cisco Unified Communications Manager Express SCCP Integration Guide for Cisco Unity Connection Release 10.x
Available Languages
Table of Contents
Task List to Create the Integration
Integrations with Multiple Phone Systems
Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection
The Number Voice of Messaging Ports to Install
The Number of Voice Messaging Ports That Will Answer Calls
The Number of Voice Messaging Ports That Will Dial Out, and Not Answer Calls
Considerations for a Cisco Unity Connection Cluster
When Both Cisco Unity Connection Servers Are Functioning Normally
When Only One Cisco Unity Connection Server Is Functioning
Creating a New Integration with Cisco Unified Communications Manager Express
Adding New User Templates for Multiple Integrations
Appendix: Documentation and Technical Assistance
Cisco Unity Connection Documentation
Obtaining Documentation and Submitting a Service Request
Cisco Product Security Overview
Cisco Unified Communications Manager Express SCCP Integration Guide for Cisco Unity Connection Release 10.x
This document provides instructions for setting up a Cisco Unified Communications Manager Express Skinny Call Control Protocol (SCCP) integration with Cisco Unity Connection.
This document does not apply to the configuration in which Cisco Unity Connection is installed as Cisco Business Edition—on the same server with Cisco Unified Communications Manager.
Cisco Unity Connection can integrate with Cisco Unified CM Express in SRST mode. For details, see the Integrating Cisco Unity Connection 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.
Integration Tasks
Before doing the following tasks to integrate Cisco Unity Connection with Cisco Unified Communications Manager Express by SCCP, confirm that Cisco Unity Connection is ready for the integration by completing the applicable tasks in the Install, Upgrade and Maintenance Guide for Cisco Unity Connection.
The following task list describes the process for creating the integration.
Task List to Create the Integration
Use the following task list to set up a Cisco Unified CM Express SCCP integration.
1.
Review the system and equipment requirements to confirm that all phone system and Cisco Unity Connection server requirements have been met. See the “Requirements” section.
2.
3.
4.
5.
6.
Requirements
The Cisco Unified CM Express SCCP integration supports configurations of the following components:
For details on compatible versions of Cisco Unified CM Express, see the SCCP Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.
–
For a list of supported Cisco IP phone models, see the applicable compatibility information document at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_list.html.
- A compatible Cisco IOS software version. See the Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_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 Connection port.
- Analog phones connected to ATA. (For integration limitations with these phones, see the “Integration Description” section.)
- A LAN Unity Connection in each location where you will plug the applicable phone into the network.
- The applicable version of Cisco Unity Connection. For details on compatible versions of Cisco Unity Connection, see the SCCP Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.
- Cisco Unity Connection installed and ready for the integration, as described in the Install, Upgrade and Maintenance Guide for Cisco Unity Connection at http://www.cisco.com/en/US/products/ps6509/prod_installation_guides_list.html.
- A license that enables the applicable number of voice messaging ports.
Cisco Unity Connection supports centralized voice messaging through the phone system, which supports various inter-phone system networking protocols including proprietary protocols such as Avaya DCS, Nortel MCDN, or Siemens CorNet, and standards-based protocols such as QSIG or DPNSS. Note that centralized voice messaging is a function of the phone system and its inter-phone system networking, not voicemail. Unity Connection will support centralized voice messaging as long as the phone system and its inter-phone system networking are properly configured. For details, see the “Centralized Voice Messaging” section in the “Integrating Cisco Unity Connection with the Phone System” chapter of the Design Guide for Cisco Unity Connection Release 10.x at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/10x/design/guide/10xcucdgx.html.
Integration Description
The Cisco Unified Communications Manager (CM) Express SCCP integration uses a LAN to connect Cisco Unity Connection and the phone system. The Cisco Unified Communications Manager Express router also provides connections to the PSTN. Figure 1 shows the connections for a system with a single Cisco Unified CM Express router.
Figure 1 Connections Between a Single Cisco Unified Communications Manager Express Router and Cisco Unity Connection
Figure 2 shows the connections for a system with multiple Cisco Unified CM Express router and a single Cisco Unity Connection server. One Cisco Unified CM Express router acts as the SIP MWI server, and the remaining Cisco Unified CM Express routers act as SIP MWI clients. Note that Cisco Unity Connection voice messaging ports register with only the SIP MWI server (the Cisco Unified CM Express router that is on the same LAN as the Cisco Unity Connection server), not with the SIP MWI clients.
Figure 2 Connections Between Multiple Cisco Unified Communications Manager Express Routers and a Single Cisco Unity Connection Server
For a list of supported versions of Cisco Unified CM Express that are qualified to integrate with Cisco Unity Connection by Skinny Call Control Protocol (SCCP), see the SCCP Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.
This document does not apply to the configuration in which Cisco Unity Connection is installed as Cisco Business Edition—on the same server with Cisco Unified CM.
Call Information
The phone system sends the following information with forwarded calls:
- The extension of the called party
- The extension of the calling party (for internal calls) or the phone number of the calling party (if it is an external call and the system uses caller ID)
- The reason for the forward (the extension is busy, does not answer, or is set to forward all calls)
Cisco Unity Connection uses this information to answer the call appropriately. For example, a call forwarded to Cisco Unity Connection is answered with the personal greeting of the user. If the phone system routes the call to Cisco Unity Connection without this information, Cisco Unity Connection answers with the opening greeting.
Integration Functionality
The Cisco Unified CM Express SCCP integration with Cisco Unity Connection provides the following features:
- Call forward to personal greeting
- Call forward to busy greeting
- Caller ID
- Easy message access (a user can retrieve messages without entering an ID; Cisco Unity Connection identifies a user based on the extension from which the call originated; a password may be required)
- Identified user messaging (Cisco Unity Connection automatically identifies a user 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 CM 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
When Cisco Unity Connection is installed as Cisco Business Edition—on the same server with Cisco Unified Communications Manager—Cisco Unity Connection cannot be integrated with multiple phone systems at one time.
When Cisco Unity Connection is not installed as Cisco Business Edition, Cisco Unity Connection can be integrated with two or more phone systems at one time. For information on and instructions for integrating Cisco Unity Connection with multiple phone systems, see the Multiple Phone System Integration Guide for Cisco Unity Connection Release 10.x at http://www.cisco.com/en/US/products/ps6509/products_installation_and_configuration_guides_list.html.
Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection
Before programming the phone system, you need to plan how the voice messaging ports will be used by Cisco Unity Connection. The following considerations will affect the programming for the phone system (for example, setting up the hunt group or call forwarding for the voice messaging ports):
For a Cisco Unity Connection cluster, each Cisco Unity Connection server must have enough ports to handle all voice messaging traffic in case the other server stops functioning. The Cisco Unified CM Express server must have enough ports created for all Cisco Unity Connection servers.
- The number of voice messaging ports that will answer calls.
- The number of voice messaging ports that will only dial out, for example, to send message notification, to set message waiting indicators (MWIs), and to make telephone record and playback (TRAP) connections.
The following table describes the voice messaging port settings in Cisco Unity Connection that can be set on Telephony Integrations > Port of Cisco Unity Connection Administration.
The Number Voice of Messaging Ports to Install
The number of voice messaging ports to install depends on numerous factors, including:
- The number of calls Cisco Unity Connection will answer when call traffic is at its peak.
- The expected length of each message that callers will record and that users will listen to.
- The number of users.
- The number of ports that will be set to dial out only.
- The number of calls made for message notification.
- The number of MWIs that will be activated when call traffic is at its peak.
- The number of TRAP connections needed when call traffic is at its peak. (TRAP connections are used by Cisco Unity Connection web applications to play back and record over the phone.)
- The number of calls that will use the automated attendant and call handlers when call traffic is at its peak.
- Whether a Cisco Unity Connection cluster is configured. For considerations, see the “Considerations for a Cisco Unity Connection Cluster” section.
It is best to install only the number of voice messaging ports that are needed so that system resources are not allocated to unused ports.
The Number of Voice Messaging Ports That Will Answer Calls
The calls that the voice messaging ports answer can be incoming calls from unidentified callers or from users. Typically, the voice messaging ports that answer calls are the busiest.
You can set voice messaging ports to both answer calls and to dial out (for example, to send message notifications). However, when the voice messaging ports perform more than one function and are very active (for example, answering many calls), the other functions may be delayed until the voice messaging port is free (for example, message notifications cannot be sent until there are fewer calls to answer). For best performance, dedicate certain voice messaging ports for only answering incoming calls, and dedicate other ports for only dialing out. Separating these port functions eliminates the possibility of a collision, in which an incoming call arrives on a port at the same time that Cisco Unity Connection takes the port off-hook to dial out.
If your system is configured for a Cisco Unity Connection cluster, see the “Considerations for a Cisco Unity Connection Cluster” section.
The Number of Voice Messaging Ports That Will Dial Out, and Not Answer Calls
Ports that will only dial out and will not answer calls can do one or more of the following:
- Notify users by phone, pager, or email of messages that have arrived.
- Turn MWIs on and off for user extensions.
- Make a TRAP connection so that users can use the phone as a recording and playback device in Cisco Unity Connection web applications.
Typically, these voice messaging ports are the least busy ports.
If your system is configured for a Cisco Unity Connection cluster, see the “Considerations for a Cisco Unity Connection Cluster” section.
Considerations for a Cisco Unity Connection Cluster
If your system is configured for a Cisco Unity Connection cluster, consider how the voice messaging ports will be used in different scenarios.
When Both Cisco Unity Connection Servers Are Functioning Normally
- The phone system is provisioned with twice the number SCCP ephone devices needed to handle the voice messaging traffic.
- A hunt group is configured on the phone system to send incoming calls first to the subscriber server, then to the publisher server if no answering ports are available on the subscriber server.
- Both Cisco Unity Connection servers are active and handle voice messaging traffic for the system.
- In Cisco Unity Connection Administration, the voice messaging ports that connect to the SCCP ephone devices are configured so that an equal number of voice messaging ports are assigned to each Cisco Unity Connection server. This guide directs you to assign the voice messaging ports to their specific server at the applicable time.
- The voice messaging ports on both Cisco Unity Connection servers are registered with the phone system.
- The number of voice messaging ports that are assigned to one Cisco Unity Connection server must be sufficient to handle all of the voice messaging traffic for the system (answering calls and dialing out) when the other Cisco Unity Connection server stops functioning.
If both Cisco Unity Connection servers must be functioning to handle the voice messaging traffic, the system will not have sufficient capacity when one of the servers stops functioning.
If all the voice messaging ports are assigned to one Cisco Unity Connection server, the other Cisco Unity Connection server will not be able to answer calls or to dial out.
When Only One Cisco Unity Connection Server Is Functioning
- The SCCP ephone devices on the phone system are unregistered from the voice messaging ports on the Cisco Unity Connection server that stopped functioning.
- The hunt group on the phone system sends all calls to the functioning Cisco Unity Connection server.
- The functioning Cisco Unity Connection server receives all voice messaging traffic for the system.
- The number of voice messaging ports that are assigned to the functioning Cisco Unity Connection server must be sufficient to handle all of the voice messaging traffic for the system (answering calls and dialing out).
- The functioning Cisco Unity Connection server must have voice messaging ports that will answer calls and that can dial out (for example, to set MWIs).
If the functioning Cisco Unity Connection server does not have voice messaging ports for answering calls, the system will not be able to answer incoming calls. Similarly, if the functioning Cisco Unity Connection server does not have voice messaging ports for dialing out, the system will not be able to dial out (for example, to set MWIs).
Programming the Cisco Unified Communications Manager Express Phone System for Integrating with Cisco Unity Connection
After the Cisco Unified Communications Manager Express router is installed, do the procedures in the applicable section depending on the Cisco Unity Connection configuration or on the number of Cisco Unified CM Express routers that you will integrate with Cisco Unity Connection:
- Cisco Unity Connection without a Unity Connection cluster—see the “Programming a Cisco Unified Communications Manager Express Router to Integrate with Cisco Unity Connection (Without a Unity Connection Cluster)” section.
- Cisco Unity Connection with a Unity Connection cluster configured—see the “Programming a Cisco Unified Communications Manager Express Router to Integrate with Cisco Unity Connection with a Unity Connection Cluster Configured” section.
- Multiple Cisco Unified Communications Manager Express routers—see the “Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with Cisco Unity Connection” section.
Programming a Cisco Unified Communications Manager Express Router to Integrate with Cisco Unity Connection (Without a Unity Connection Cluster)
Note
To Configure the Message Button Access to Cisco Unity Connection (Without a Unity Connection Cluster)
This procedure configures the Message button on Cisco IP phones to dial the Cisco Unity Connection pilot number when pressed.
Step 1
Step 2
voicemail <Cisco Unity Connection pilot number>
Step 3
The following is an example of the configuration:
To Configure the Router for Cisco Unity Connection (Without a Unity Connection Cluster)
Step 1
- For ephone-dns that will be used by ports that are dedicated for leaving and retrieving voice messages, enter the following command:
Step 2
number <Voice messaging port extension>
Note
Step 3
name <Display name of voice messaging port>
Step 4
description <Device name of voice messaging port>
Step 5
Step 6
Step 7
Step 8
Note
Step 9
The following is an example of the configuration without a Cisco Unity Connection cluster:
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 5001 and is used to dial out by Cisco Unity Connection (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 Connection, and outgoing calls that Cisco Unity Connection places in the opposite direction.
To Associate the Voice Messaging Port (Without a Unity Connection Cluster)
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 Connection device name prefix><Port number>
The vm-device-id name must match the Cisco Unity Connection voice messaging port name that you will use to identify the port in Cisco Unity Connection Administration when you create the integration:
- The Cisco Unity Connection device name prefix part (for example, CUC1-VI) must match the Device Name Prefix field on the Telephony Integrations > Port Group > Port Group Basics page of Cisco Unity Connection Administration.
- The port number part (for example, “1”) must match the number part of the Cisco Unity Connection Administration voice messaging port name used to identify the port on the Telephony Integrations > Port > Port Basics page of Cisco Unity Connection Administration.
To associate a voice messaging port to the Cisco Unified CM Express router, do the following steps, beginning in ephone configuration mode.
Step 1
Step 2
vm-device-id <Cisco Unity Connection device name prefix><Port number>
For example, if the Cisco Unity Connection device name prefix is CUC1-VI, enter CUC1-VI1 for the first port, CUC1-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 Connection. Otherwise, the integration will not work.
Step 3
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
Note
Step 5
Following is an example of the configuration without a Cisco Unity Connection cluster. 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 (Without a Unity Connection Cluster)
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 Connection. You must allocate a minimum of one MWI processing ephone-dn for each MWI ephone-dn voice messaging port. The MWI processing ephone-dn extensions are configured to match the MWI extensions configured on Cisco Unity Connection.
Step 1
Step 2
number <MWI on number> secondary <MWI off number>
Note
Step 3
Step 4
Following is an example of the configuration.
In this example, Cisco Unity Connection calls extensions 8000 and 8001 to turn MWIs on and off. The DN triggers an MWI ON event when 8000 is called, and an MWI OFF event when 8001 is called.
For extensions associated with analog telephone adaptors (ATAs), the MWI is a lit function button on the ATA and a stutter dial tone on the connected analog phone.
Note
Programming a Cisco Unified Communications Manager Express Router to Integrate with Cisco Unity Connection with a Unity Connection Cluster Configured
Note
To Configure the Message Button Access to Cisco Unity Connection (With a Unity Connection Cluster Configured)
This procedure configures the Message button on Cisco IP phones to dial the Cisco Unity Connection pilot number when pressed.
Step 1
Step 2
voicemail <Cisco Unity Connection pilot number>
Step 3
The following is an example of the configuration:
To Configure the Router for Cisco Unity Connection (With a Unity Connection Cluster Configured)
Step 1
- For ephone-dns that will be used by ports that are dedicated for leaving and retrieving voice messages, enter the following command:
Step 2
number <Voice messaging port extension>
Note
Step 3
name <Display name of voice messaging port>
Step 4
description <Device name of voice messaging port>
Step 5
Step 6
Note
Step 7
Step 8
Note
Step 9
The following is an example of the configuration with a Cisco Unity Connection cluster configured:
In this example, there are two sets of ephone-dns:
- Four ephone-dns are configured for the publisher server in the Unity Connection cluster (CUC1-VI1 through CUC1_VI3, and CUC1-Dialout1).
- Four ephone-dns are configured for the subscriber server in the Unity Connection cluster (CUC2-VI1 through CUC2_VI3, and CUC2-Dialout1).
The hunt group routes calls first to the subscriber server in the Unity Connection cluster. When all the answering ports on the subscriber server are busy, the hunt group routes calls to the publisher server. Only the last answering ephone-dn for the publisher server has enabled huntstop so that the hunt group will search through the answering ephone-dns on all Cisco Unity Connection servers. The ephone-dns that are used for dialing out are not included in the hunt group.
To Associate the Voice Messaging Port (With a Unity Connection Cluster Configured)
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 Connection device name prefix><Port number>
The vm-device-id name must match the Cisco Unity Connection voice messaging port name that you will use to identify the port in Cisco Unity Connection Administration when you create the integration:
- The Cisco Unity Connection device name prefix part (for example, CUC1-VI) must match the Device Name Prefix field on the Telephony Integrations > Port Group > Port Group Basics page of Cisco Unity Connection Administration.
- The port number part (for example, “1”) must match the number part of the Cisco Unity Connection Administration voice messaging port name used to identify the port on the Telephony Integrations > Port > Port Basics page of Cisco Unity Connection Administration.
To associate a voice messaging port to the Cisco Unified CM Express router, do the following steps, beginning in ephone configuration mode.
Step 1
Step 2
vm-device-id <Cisco Unity Connection device name prefix><Port number>
For example, if the Cisco Unity Connection device name prefix is CUC1-VI, enter CUC1-VI1 for the first port, CUC1-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 Connection. Otherwise, the integration will not work.
Step 3
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
Note
Step 5
The following is an example of the configuration with a Cisco Unity Connection cluster configured. 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 (With a Unity Connection Cluster Configured)
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 Connection. You must allocate a minimum of one MWI processing ephone-dn for each MWI ephone-dn voice messaging port. The MWI processing ephone-dn extensions are configured to match the MWI extensions configured on Cisco Unity Connection.
Step 1
Step 2
number <MWI on number> secondary <MWI off number>
Note
Step 3
Step 4
Following is an example of the configuration.
In this example, Cisco Unity Connection calls extensions 8000 and 8001 to turn MWIs on and off. The DN triggers an MWI ON event when 8000 is called, and an MWI OFF event when 8001 is called.
For extensions associated with analog telephone adaptors (ATAs), the MWI is a lit function button on the ATA and a stutter dial tone on the connected analog phone.
Note
Programming Multiple Cisco Unified Communications Manager Express Routers to Integrate with Cisco Unity Connection
Cisco Unity Connection 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 Cisco Unity Connection, and that this Cisco Unified CM Express router register all Cisco Unity Connection voice messaging ports. This Cisco Unified CM Express router (the SIP MWI server) is a proxy server that relays SIP MWI messages between Cisco Unity Connection and all other Cisco Unified CM Express routers (the SIP MWI clients). Note that Cisco Unity Connection voice messaging ports register with only the SIP MWI server (the Cisco Unified CM Express router that is on the same LAN as Cisco Unity Connection), not with the SIP MWI clients.
Note
To Configure the Message Button Access to Cisco Unity Connection (Multiple Cisco Unified CM Express Routers)
Step 1
Step 2
voicemail <Cisco Unity Connection pilot number>
Step 3
The following is an example of the configuration:
To Configure the Router for Cisco Unity Connection (Multiple Cisco Unified CM Express Routers)
Step 1
- For ephone-dns that will be used by ports that are dedicated for leaving and retrieving voice messages, enter the following command:
Step 2
number <Voice messaging port extension>
Note
Step 3
name <Display name of voice messaging port>
Step 4
description <Device name of voice messaging port>
Step 5
Step 6
Note
Step 7
Step 8
Note
For a Cisco Unity Connection cluster, the number of voice messaging ports must be the total of the ports on all Cisco Unity Connection servers in the Cisco Unity Connection cluster.
Step 9
The following is an example of the configuration without a Cisco Unity Connection cluster:
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 5001 and is used to dial out by Cisco Unity Connection (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 Connection, and outgoing calls that Cisco Unity Connection places in the opposite direction.
The following is an example of the configuration with a Cisco Unity Connection cluster configured:
In this example, there are two sets of ephone-dns:
- Four ephone-dns are configured for the publisher server in the Unity Connection cluster (CUC1-VI1 through CUC1_VI3, and CUC1-Dialout1).
- Four ephone-dns are configured for the subscriber server in the Unity Connection cluster (CUC2-VI1 through CUC2-VI3, and CUC2-Dialout1).
The hunt group routes calls first to the subscriber server in the Unity Connection cluster. When all the answering ports on the subscriber server are busy, the hunt group routes calls to the publisher server. Only the last answering ephone-dn for the publisher server has enabled huntstop so that the hunt group will search through the answering ephone-dns on all Cisco Unity Connection servers. The ephone-dns that are used to dial out are not included in the hunt group.
To Associate the Voice Messaging Port (Multiple Cisco Unified CM Express Routers)
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 Connection device name prefix><Port number>
The vm-device-id name must match the Cisco Unity Connection voice messaging port name you will use to identify the port in Cisco Unity Connection Administration when you create the integration:
- The Cisco Unity Connection device name prefix part (for example, CUC1-VI) must match the Device Name Prefix field on the Telephony Integrations > Port Group page.
- The port number part (for example, “1”) must match the number part of the Cisco Unity Connection voice messaging port name used to identify the port on the Telephony Integrations > Port page.
To associate a voicemail device with the Cisco Unified CM Express router, do the following steps, beginning in ephone configuration mode.
Step 1
Step 2
vm-device-id <Cisco Unity Connection device name prefix><Port number>
For example, if the Cisco Unity Connection device name prefix is CUC1-VI, enter CUC1-VI1 for the first port, CUC1-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 Connection. Otherwise, the integration will not work.
Step 3
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
Note
Step 5
Following is an example of the configuration without a Cisco Unity Connection cluster. 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.
The following is an example of the configuration with a Cisco Unity Connection cluster configured:
To Configure the SIP MWI Server (Multiple Cisco Unified CM Express Routers)
Step 1
Step 2
mwi-server {ipv4:<MWI server IP address> | dns:<MWI server host-name>} [expires <Seconds>]
[port <Port number>] [transport {tcp | udp}] [unsolicited]The SIP MWI server must be in the same LAN as Cisco Unity Connection. This IP address is used in conjunction with the “mwi sip” command in ephone-dn configuration mode to subscribe individual ephone-dn extension numbers to the MWI server notification list. The SIP MWI client runs TCP by default.
This command uses the following keywords:
- ipv4: —Sets the IP address of the SIP MWI server.
- dns: —Sets the DNS name of the SIP MWI server.
- expires — (optional) Subscription expiration time, in seconds. The range is 1 to 999999. The default is 3600.
- transport tcp —The default setting.
- transport udp —Allows you to integrate with the SIP MWI client.
- port —Used to specify the TCP port for the SIP MWI server. The default SIP port number is 5060.
- unsolicited —Allows sending SIP NOTIFY for MWIs without the need to send a SUBSCRIBE from the Cisco Unified CM Express router.
Step 3
Step 4
Step 5
Step 6
Step 7
To Configure MWIs for Each Directory Number (Multiple Cisco Unified CM Express Routers)
Step 1
Step 2
Step 3
Step 4
This command integrates the Cisco Unified CM Express with the MWI service based on SIP protocol.
Note
Step 5
To Configure a Directory Number for MWI Notification (Multiple Cisco Unified CM Express Routers)
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 Connection. You must allocate a minimum of one MWI processing ephone-dn for each MWI ephone-dn voice messaging port. The MWI processing ephone-dn extensions are configured to match the MWI extensions configured on Cisco Unity Connection.
Step 1
Step 2
number <MWI on number> secondary <MWI off number>
Note
Step 3
Step 4
Following is an example of the configuration.
In this example, Cisco Unity Connection calls extensions 8000 and 8001 to turn MWIs on and off. The DN triggers an MWI ON event when 8000 is called, and an MWI OFF event when 8001 is called.
To Configure MWI Relay (Multiple Cisco Unified CM Express Routers)
MWI relay is required when Cisco Unity Connection 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
Step 2
Step 3
Step 4
Step 5
mwi-server {ipv4:<MWI server IP address> | dns:<MWI server host-name} [expires <Seconds>]
[port <Port number>] [transport {tcp | udp}] [unsolicited]The SIP MWI server must be in the same LAN as Cisco Unity Connection. This IP address is used in conjunction with the “mwi sip” command in ephone-dn configuration mode to subscribe individual ephone-dn extension numbers to the MWI server notification list. The SIP MWI client runs TCP by default.
This command uses the following keywords:
- ipv4: —Sets the IP address of the SIP MWI server.
- dns: —Sets the DNS name of the SIP MWI server.
- expires — (optional) Subscription expiration time, in seconds. The range is 1 to 999999. The default is 3600.
- transport tcp —The default setting.
- transport udp —Allows you to integrate with the SIP MWI client.
- port —Used to specify the TCP port for the SIP MWI server. The default SIP port number is 5060.
- unsolicited —Allows sending SIP NOTIFY for MWIs without the need to send a SUBSCRIBE from the Cisco Unified CM Express router.
Step 6
Step 7
Step 8
Step 9
To Enable DTMF Relay (Multiple Cisco Unified CM Express Routers)
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 Connection is integrated) must be configured to enable DTMF relay.
The Catalyst 6000 T1/PRI and FXS gateways enable DTMF relay by default and do not need additional configuration to enable this feature.
Step 1
Step 2
Step 3
Creating a New Integration with Cisco Unified Communications Manager Express
After ensuring that Cisco Unified Communications Manager Express and Cisco Unity Connection are ready for the integration, do the following procedure to set up the integration and to enter the port settings.
Step 1
Step 2
Step 3
Step 4
Step 5
Step 7
Step 8
Table 2 Settings for the New Port Group Page (Answering Port Group)
Select the name of the phone system that you entered in Step 4.
Select Port Group Template and select SCCP in the drop-down box.
Enter a descriptive name for the port group. You can accept the default name or enter the name that you want. For example, enter “CUC1-VI.”
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 for the answering ephone-dns by Cisco Unified CM Express.
For a Cisco Unity Connection cluster, this prefix must match the prefix used for the answering ephone-dns that will connect to the publisher server.
(This field is not used by the answering port group.) Enter the MWI on directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
(This field is not used by the answering port group.) Enter the MWI off directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Do not enter a value in this field. IPv6 is not supported for Cisco Unified CM Express integrations.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Enter the TCP port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Enter the TLS port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Step 9
Step 10
Step 11
Step 12
Step 13
Enter the number of answering voice messaging ports that you want to create in this port group.
For a Cisco Unity Connection cluster, enter half of the total number of answering voice messaging ports that will be used by all servers in the Cisco Unity Connection cluster. Later, you will create a second answering port group for the remaining answering voice messaging ports.
Select the name of the phone system that you entered in Step 4.
Select the name of the port group that you added in Step 8.
Select the name of the Cisco Unity Connection server.
For a Cisco Unity Connection cluster, select the name of the publisher Cisco Unity Connection server in the Cisco Unity Connection cluster.
(Cisco Unified Communications Manager authentication and encryption are not available for Cisco Unified CM Express.)
Step 14
Note
Step 15
Step 18
Step 19
Step 20
Step 21
Table 5 Settings for the New Port Group Page (Dial-out Port Group)
Select the name of the phone system that you entered in Step 4.
Select Port Group Template and select SCCP in the drop-down box.
Enter a descriptive name for the port group. You can accept the default name or enter the name that you want. For example, enter “CUC1-Dialout.”
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 for the dial-out ephone-dns by Cisco Unified CM Express.
For a Cisco Unity Connection cluster, this prefix must match the prefix used for the dial-out ephone-dns that will connect to the publisher server.
Enter the MWI on directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
Enter the MWI off directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Do not enter a value in this field. IPv6 is not supported for Cisco Unified CM Express integrations.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Enter the TCP port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Enter the TLS port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Step 22
Step 23
Step 24
Step 25
Step 26
Enter the number of dial-out voice messaging ports that you want to create in this port group.
For a Cisco Unity Connection cluster, enter half of the total number of dial-out voice messaging ports that will be used by all servers in the Cisco Unity Connection cluster. Later, you will create a second dial-out port group for the remaining dial-out voice messaging ports.
Select the name of the phone system that you entered in Step 4.
Select the name of the port group that you added in Step 21.
Select the name of the Cisco Unity Connection server.
For a Cisco Unity Connection cluster, select the name of the publisher Cisco Unity Connection server in the Cisco Unity Connection cluster.
(Cisco Unified Communications Manager authentication and encryption are not available for Cisco Unified CM Express.)
Step 27
Note
Step 28
Step 31
Step 32
Step 33
Step 34
Table 8 Settings for the New Port Group Page (Answering Port Group)
Select the name of the phone system that you entered in Step 4.
Select Port Group Template and select SCCP in the drop-down box.
Enter a descriptive name for the port group. You can accept the default name or enter the name that you want. For example, enter “CUC2-VI.”
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 for the answering ephone-dns for the subscriber server by Cisco Unified CM Express.
(This field is not used by the answering port group.) Enter the MWI on directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
(This field is not used by the answering port group.) Enter the MWI off directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Do not enter a value in this field. IPv6 is not supported for Cisco Unified CM Express integrations.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Enter the TCP port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Enter the TLS port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Step 35
Step 36
Step 37
Step 38
Step 39
Enter the answering voice messaging ports that will be used by the subscriber server in the Cisco Unity Connection cluster.
Select the name of the phone system that you entered in Step 4.
Select the name of the port group that you added in Step 34.
Select the name of the subscriber Cisco Unity Connection server in the Cisco Unity Connection cluster.
(Cisco Unified Communications Manager authentication and encryption are not available for Cisco Unified CM Express.)
Step 40
Note
Step 41
Step 44
Step 45
Step 46
Step 47
Table 11 Settings for the New Port Group Page (Dial-out Port Group)
Select the name of the phone system that you entered in Step 4.
Select Port Group Template and select SCCP in the drop-down box.
Enter a descriptive name for the port group. You can accept the default name or enter the name that you want. For example, enter “CUC2-Dialout.”
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 for the dial-out ephone-dns for the subscriber server by Cisco Unified CM Express.
Enter the MWI on directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
Enter the MWI off directory number that you specified in the ephone-dn configuration mode of the Cisco Unified CM Express router.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Do not enter a value in this field. IPv6 is not supported for Cisco Unified CM Express integrations.
Enter the IP address (or host name) of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection.
Enter the TCP port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Enter the TLS port of the Cisco Unified CM Express router that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
Step 48
Step 49
Step 50
Step 51
Step 52
Enter the dial-out voice messaging ports that will be used by the subscriber server in the Cisco Unity Connection cluster.
Select the name of the phone system that you entered in Step 4.
Select the name of the port group that you added in Step 47.
Select the name of the subscriber Cisco Unity Connection server in the Cisco Unity Connection cluster.
(Cisco Unified Communications Manager authentication and encryption are not available for Cisco Unified CM Express.)
Step 53
Note
Step 54
Step 57
Step 58
Step 59
Step 60
Step 61
Step 62
If the test is not successful, the Task Execution Results displays one or more messages with troubleshooting steps. After correcting the problems, test the connection again.
Step 63
Testing the Integration
To test whether Cisco Unity Connection and the phone system are integrated correctly, do the following procedures in the order listed.
If any of the steps indicate a failure, see the following documentation as applicable:
- The installation guide for the phone system.
- Troubleshooting Guide for Cisco Unity Connection Release 10.x at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/10x/troubleshooting/guide/10xcuctsgx.html.
- The setup information earlier in this guide.
To Set Up the Test Configuration
Step 1
Step 2
Caution The phone system must forward calls to the Cisco Unity Connection pilot number in no fewer than four rings. Otherwise, the test may fail.
Step 3
Step 4
Step 5
Step 6
Step 8
Step 9
Step 10
Step 12
Step 13
Step 14
Step 15
Step 17
Do not close the Cisco Unity Connection Administration window because you will use it again in a later procedure.
Step 18
Step 19
Step 20
To Test an External Call with Release Transfer
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
Step 9
Step 10
Step 1
Step 2
Step 3
Step 5
Step 6
Step 8
To Set Up Supervised Transfer on Cisco Unity Connection
Step 1
Step 2
Step 4
Do not close the Cisco Unity Connection Administration window because you will use it again in a later procedure.
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
Adding New User Templates for Multiple Integrations
When you create the first phone system integration, this first phone system is automatically selected in the default user template. The users that you add after creating this phone system integration will be assigned to this phone system by default.
However, for each additional phone system integration that you create, you must add the applicable new user templates that will assign users to the new phone system. You must add the new templates before you add new users who will be assigned to the new phone system.
For details on adding new user templates, or on selecting a user template when adding a new user, see the “Adding, Modifying, or Deleting a User Template in Cisco Unity Connection 10.x” and the “Preparing to Add User Accounts in Cisco Unity Connection 10.x” chapters of the User Moves, Adds, and Changes Guide for Cisco Unity Connection Release 10.x. The guide is available at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/10x/user_mac/guide/10xcucmacx.html.
Documentation Conventions
The Cisco Unified Communications Manager Express SCCP Integration Guide for Cisco Unity Connection Release 10.x uses the following conventions.
The Cisco Unified Communications Manager Express SCCP Integration Guide for Cisco Unity Connection Release 10.x also uses the following conventions:
Note
Cisco Unity Connection Documentation
For descriptions and URLs of Cisco Unity Connection documentation on Cisco.com, see the Documentation Guide for Cisco Unity Connection. The document is shipped with Cisco Unity Connection and is available at http://www.cisco.com/en/US/products/ps6509/products_documentation_roadmaps_list.html.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.
Cisco Product Security Overview
This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.
Further information regarding U.S. export regulations can be found at http://www.access.gpo.gov/bis/ear/ear_data.html.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Feedback