Configure MWI Using SIP Notify

This topic describes how to configure Cisco Unity Express to use the SIP Notify MWI process.

  • Configure SIP MWI notification for subscribed users or unsolicited service.
  • Specify the SIP Subscribe Notify or Unsolicited mechanism.
  • Define the DTMF relay method for transferring DTMF signals to match the dial-peer configuration.
  • Must match MWI configuration in Cisco Unified Communications Manager Express.
ccn subsystem sip
  gateway address “”
  mwi sip unsolicited  dtmf-relay sip-notify
 end subsystem

To set the MWI notification mechanism, use the mwi sip command in Cisco Unity Express SIP configuration mode: mwi sip {outcall | sub-notify | unsolicited}.

Both Cisco Unified Communications Manager Express and Cisco Unified Communications Manager in Cisco Unified SRST mode can use the sub-notify and unsolicited mechanisms for generating MWI notifications. With these mechanisms, the MWI notifications will reflect the accurate status of messages in a subscriber voice mailbox.

After an ephone-dn is configured with the sub-notify option, Cisco Unified Communications Manager Express sends a Subscribe message to Cisco Unity Express to register the phone for MWI notifications. When a new voice message arrives in the voice mailbox for the ephone-dn, Cisco Unity Express updates the MWI status. If Cisco Unity Express does not receive the Subscribe message for the ephone-dn, Cisco Unity Express will not update the MWI status when a new message arrives.

To use the sub-notify option, Cisco Unified Communications Manager Express must configure each ephone-dn that is registered in order to receive MWI notifications as follows:

   mwi-server ipv4: 
ephone-dn 1 
  mwi sip

To set the SIP DTMF relay mechanism, use the dtmf-relay command in Cisco Unity Express SIP configuration mode. Administrators may configure more than one option for transferring DTMF signals. The order in which you configure the options determines their order of preference. To configure more than one signal option, specify them by using a single dtmf-relay command:

  • dtmf-relay {cisco-rtp | h245-alphanumeric | h245-signal | rtp-nte | sip-info | sip-kpml | sip-notify}
    1. rtp-nte: This option uses the media path to relay incoming and outgoing DTMF signals to Cisco Unity Express.
    2. sip-info: This option uses the Info message to relay outgoing DTMF signals from Cisco Unity Express to the Cisco IOS SIP gateway.
    3. sip-kpml: This option uses KPML with SIP Subscribe and Notify messages to relay DTMF signals.
    4. sip-notify: This option uses Unsolicited SIP Notify messages to relay incoming and outgoing DTMF signals.

To use the sip-notify option, verify that Cisco Unified Communications Manager Express (or the Cisco IOS SIP gateway) is configured to use Unsolicited Notify for SIP calls, as shown in the following example:

dial-peer voice 4500 voip 
 destination-pattern 45.. 
 session protocol sipv2 
 session target ipv4: 
 dtmf-relay sip-notify 
 codec g711ulaw 
 no vad

Configure MWI Outcall Directory Numbers

This topic describes how to configure Cisco Unity Express to use the outcall MWI process.

  • Configure Cisco Unity Express for MWI directory numbers: MWI on and MWI off.
  • Must match MWI directory numbers configured in Cisco Unified Communications Manager Express.
ccn application ciscomwiapplication aa
  maxsessions 10
  script "setmwi.aef"
  parameter "CallControlGroupID" "0“
  parameter “strMWI_OFF_DN” “4599”
  parameter “strMWI_ON_DN” “4598”
  end application

The outcall MWI process requires two ephone-dns to be defined in Cisco Unified Communications Manager Express. To activate this feature, modify the MWI_ON and MWI_OFF parameters, under the ciscomwiapplication application in Cisco Unity Express, to reflect the configured directory numbers. Here is an example:

  • parameter “strMWI_OFF_DN” “4599
  • parameter “strMWI_ON_DN” “4598

To set the MWI notification mechanism, use the mwi sip outcall command in Cisco Unity Express SIPconfiguration mode:

  • mwi sip {outcall | sub-notify | unsolicited}

Only Cisco Unified Communications Manager Express can use the SIP outcall mechanism to generate MWI notifications. The outcall will not work between Cisco Unity Express and a Cisco Unified Communications Manager system. The outcall option is available for backward compatibility. It is recommended that you use either sub-notify or unsolicited for the MWI notification option.

To use the outcall option, configure ephone-dns on Cisco Unified Communications Manager Express to receive MWI notifications as follows:

ephone-dn 9 
  number 4598.... 
  mwi on 
ephone-dn 10 
  number 4599.... 
  mwi off

Configure SIP Triggers for Default Applications: Voicemail

This topic describes the configuration of the trigger number in Cisco Unity Express that answers incoming calls to the voice-messaging system.

  • Configure the directory number that triggers the voicemail process.
  • Enable voicemail.
  • Set the maximum concurrent sessions to six, for example.
ccn trigger sip phonenumber 4500
 application “voicemail”
 maxsessions 6
 end trigger

The administrator must define the SIP triggers that will invoke Cisco Unity Express applications such as voicemail or the auto-attendant. The figure shows the Cisco Unity Express CLI commands that configure a trigger number that activates the voicemail application when the SIP connection called party equals 4500.

The following parameters are configured for the SIP trigger:

  • Telephone number that triggers the application
  • Application name
  • Maximum number of sessions that are allowed for the application

The maximum sessions cannot exceed the system limit.

Software Versions and Licenses

This topic describes how to view Cisco Unity Express information such as the installed software and version.

  • Displays the most common options to show information such as version of the installed software packages and system languages
show software {directory | download | install | packages | versions}
  • Install and view Cisco Unity Express licenses
license install URL
show license {agent | all | detail evaluation | expiring | feature | file | in-use | permanent | statistics | status | udi}

To display the characteristics of the installed software, use the show software command in Cisco Unity Express EXEC mode. The following main options are available:

  • directory: This option displays the software directory.
  • download: This option displays the IP address of the FTP server.
  • install: This option displays installed software.
  • packages: This option displays the configured Cisco Unity Express application packages.
  • versions: This option displays the current versions of the configured software and applications.

Here is an example of the show software command output:

CUE# show software packages

Installed Packages:

 - Installed Packages: 

 - Installer (Installer application) ( 
 - Thirdparty (Service Engine Thirdparty Code) (8.6.9) 
 - Infrastructure (Service Engine Infrastructure) (8.6.9)
 - Global (Global manifest) (8.6.9) 
 - GPL Infrastructure (Service Engine GPL Infrastructure) (8.6.9) 
 - Voice Mail (Voicemail application) (8.6.9) 
 - Bootloader (Secondary) (Service Engine Bootloader) (2.1.36) 
 - Core (Service Engine OS Core) (8.6.9) 
 - Auto Attendant (Service Engine Telephony Infrastructure) (8.6.9) 

Installed Plug-ins:

 - CUE Voicemail Language Support (Languages global pack) (8.6.9) 
 - CUE Voicemail US English (English language pack) (8.6.9) 

CUE# show software versions
Cisco Unity Express version (8.6.9)
Technical Support: Copyright (c) 1986-2014 by Cisco Systems, Inc.


 - CUE Voicemail Language Support version  8.6.9 

Customers must purchase licenses in order to use Cisco Unity Express features. These licenses must be downloaded and installed on the Cisco Unity Express system. It is possible to upgrade and downgrade licenses.

Cisco Unity Express 8.x licenses are based on the Cisco Software Licensing system. With Cisco software licenses, the mailbox license count includes both personal mailboxes and GDMs. The type of the mailbox is determined when it is configured. Also, the call agent is no longer specified using licenses and can be configured either as part of the postinstallation process or during the boot. Cisco Unity Express software activation enables the various feature sets on a device by using license keys. Several types of licenses are available.

Permanent licenses are perpetual—they do not have any usage period that is associated with them. Once permanent licenses are installed, they provide all the permissions that are needed to access features in the software image. All permanent licenses are node-locked and validated by the licensing infrastructure during software installation. Once a permanent license is installed, it is not necessary to upgrade for subsequent releases.

Cisco manufacturing preinstalls the appropriate permanent license on the ordered device for the purchased feature set. No customer interaction with the Cisco Software Activation processes is required in order to enable a license on new hardware.

Temporary licenses are limited to a specific usage period (for example, 60 days) and a EULA must be accepted before they can be activated.

If a device failure occurs, and if the replaced device does not have the same licenses as the failed device, to avoid network downtime, customers can use an emergency license (evaluation license) that is embedded in their software image, which ensures that needed features can be configured without requiring a license key. However, the customer must still accept the EULA and must acknowledge that there is a 60-day usage limit for this type of license.

The Cisco Unity Express license system limits the available resources, such as the maximum number of mailboxes that are allowed or the number of ports to reach the voice-messaging system. To install the licenses, use the license install command in Cisco Unity Express EXEC mode. Use the show license command to display Cisco Unity Express license information. License information includes the following:

  • Feature: Displays the feature name
  • License Type: Evaluation, Emergency, Extension, Permanent, or Temporary
  • License State: Active, Expired, or In Use, and the license period and remaining time are displayed
  • License Count: Maximum allowed license count and number of licenses used

Software Installation

This topic describes how to download and install the Cisco Unity Express Service Module software.

  • Download software from an FTP server to install later.
    1. Clean: For a new installation
    2. Upgrade: To upgrade an existing installation
software download [abort | clean | status | upgrade]
  • Install previously downloaded software on Cisco Unity Express.
  • Option to install directly from FTP without previous download:
software install [add | clean | downgrade| upgrade]

Administrators can download the Cisco Unity Express software files and add additional language packages. Once the administrator has downloaded files to a PC, the core files can be extracted from the zip file. The extracted files and the language package files are then copied to the FTP server.

Install the Cisco Unity Express software from the FTP server. To download the software from the FTP server for a new installation, enter the software download clean command. To upgrade an existing configuration, enter the software download upgrade command to download the software from the FTP server. The status option can be used to check the download status.

Enter the software install download command to install previously downloaded software. Alternatively, thesoftware install command can be used to install software directly from an FTP server without downloading first.

Cisco Unity Express Module Connection and Initiation

This topic describes how to access the Cisco Unity Express module and initiate the Service Module.

  • Use the service-module command to control, view status, and connect to the service engine from the host Cisco Unified Communications Manager Express router.
  • This command shows only the most commonly used options:
service-module SM mod/slot [reload | session | shutdown | status]
  • This command restores the configuration of the Cisco Unity Express module to factory defaults in offline mode:
restore factory default

To access the Cisco Unity Express CLI, establish a Telnet session to the Cisco Unified Communications Manager Express router, and use the service-module command. The command offers the following options:

  • default-boot: Set or clear the default boot for the next reboot.
  • heartbeat-reset: Enable or disable the heartbeat failure to reset the Service Module.
  • install: Install an application.
  • log: Retrieve a history of logs.
  • password-reset: Reset the password for the Service Module.
  • reload: Reload the Service Module.
  • reset: Reset the hardware of the Service Module.
  • session: Connect to the Service Module.
  • shutdown: Shut down the Service Module.
  • statistics: Generate Service Module statistics.
  • status: Show Service Module information.
  • uninstall: Uninstall an application.
  • upgrade: Upgrade a currently installed application.

The Cisco Unified Communications Manager Express router service-module command is mainly used to reset, reload, view the Service Module status, or shut down the Cisco Unity Express Service Module by using thereset, reload, status, or shutdown keywords. The service-module command allows these functions without the need to log in to Cisco Unity Express.

To disconnect from the Cisco Unity Express module and return to the CLI of the host router, enter exit from the Cisco Unity Express module.

Sometimes it is necessary to wipe the Cisco Unity Express Service Module configuration clean and restore the factory default settings. Restoring the system to the factory defaults has the following effects:

  • It replaces the current database with an empty database.
  • It returns the LDAP server to an empty state.
  • It replaces the startup configuration with the template startup configuration that ships with the system.
  • It erases all postinstallation configuration data.
  • It deletes all subscriber and custom prompts.

When the system is clean, the administrator will see a message that the system will reload, and the system begins to reload. When the reload is complete, the system prompts the administrator to go through the postinstallation process. When logging in to the GUI, the administrator can run the initialization wizard.


All configurations and voicemail are lost when entering the command restore factory default. First, enter the command offline to go into offline mode. Then enter the restore factory defaultcommand.

CUE# offline
!!!WARNING!!!: If you are going offline to do a backup, it is recommended that you save the current running configuration using the 'write' command,prior to going to the offline state.

Putting the system offline will disable management interfaces.

Are you sure you want to go offline?[confirm]
CUE(offline)# restore factory default
!!!WARNING!!!: This operation will cause all configuration and data on the system to be erased. This operation is not reversible.
Do you wish to continue?[confirm]

When you log in for the first time after the postinstallation process, Cisco Unity Express prompts you with the following: se-10-1-130-2#. The abbreviations of the service engine and the IP address of the Cisco Unity Express module generate the hostname. You can specify a different hostname during the postinstallation process or at any time by using the command hostname <hostname>.


This topic explains the requirements for transcoding devices when using Cisco Unity Express and codecs other than G.711.

  • Cisco Unity Express supports G.711 calls only.
  • Transcoding is required to convert codecs when Cisco Unified Communications Manager Express uses a different codec.
    1. For example, convert G.729 to G.711 or vice versa.
    2. Used for remote teleworkers or on trunks to other branches.

Cisco Unity Express supports G.711 calls only. When callers use a different codec, calls to voicemail will fail. Transcoding is required to convert codecs when Cisco Unified Communications Manager Express uses a different codec than what Cisco Unity Express uses. For example, transcoding will convert a G.729 call to G.711 or vice versa.

External hardware transcoders are required to perform transcoding. These transcoding resources can be located locally at each messaging system site. Cisco Unified Communications Manager Express routers can be configured with DSPs that support transcoding. Hardware DSPs reside directly on a voice network module or on a PVDM2 or PVDM3 card.

The DSP resources that are used for transcoding can be internal to Cisco Unified Communications Manager Express. In this case, the transcoding is referred to as coresident transcoding. The control of coresident DSP resources is local to the Cisco Unified Communications Manager Express router.

The DSP resources that are used for transcoding may be external to the Cisco Unified Communications Manager Express system. DSP farms that are supported on Cisco IOS voice-enabled routers can be controlled by Cisco Unified Communications Manager Express by using SCCP. Using external transcoding resources allows for expansion by adding additional DSPs. External transcoding resources also allow distribution of the resources across the network to best suit the implementation. The DSP farm must be reachable within the IP network.

The following example shows how to configure a transcoder on Cisco Unified Communications Manager Express:

voice-card 0
 dsp services dspfarm

sccp local Vlan130
sccp ccm identifier 1 priority 1 version 7.0+

The version parameter used with the sccp ccm command is 7.0+, which works well with Cisco Unified Communications Manager or Cisco Unified Communications Manager Express 10.0. There is no option to select version 8, 9, or 10, because the integration is the same from a protocol perspective.


sccp ccm group 1
 associate ccm 1 priority 1
 associate profile 1 register BR-XCODE

dspfarm profile 1 transcode  
 codec g711ulaw
 codec g711alaw
 codec g729ar8
 codec g729abr8
 codec g729br8
 codec g729r8
 maximum sessions 6
 associate application SCCP

 sdspfarm units 1
 sdspfarm transcode sessions 6
 sdspfarm tag 1 BR-XCODE