Cisco Unified CME Commands: M

This chapter contains commands to configure and maintain Cisco Unified Communications Manager Express (formally known as Cisco Unified CallManager Express). The commands are presented in alphabetical order. Some commands required for configuring Cisco Unified Communications Manager Express (Cisco Unified CME) may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.

mac-address (ephone)

To associate the MAC address of a Cisco IP phone with an ephone configuration in a Cisco CallManager Express (Cisco CME) system, use the mac-address command in ephone configuration mode. To disassociate the MAC address from an ephone configuration, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

mac-address	Identifying MAC address of an IP phone, which is found on a sticker located on the bottom of the phone.


Cisco IOS Release	Cisco Product	Modification
12.1(5)YD	Cisco ITS 1.0	This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT	Cisco ITS 2.0	This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T	Cisco ITS 2.01	This command was implemented on the Cisco 1760.
12.2(15)ZJ	Cisco CME 3.0	The mac-address argument was made optional to enable automatic MAC address assignment after registration of phones.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.

Usage Guidelines

Use this command to specify the MAC address of a specific Cisco IP phone in order to physically identify the Cisco IP phone in a Cisco CME configuration. The MAC address of each Cisco IP phone is printed on a sticker that is placed on the bottom of the phone.

If you choose to register phones before configuring them, the mac-address command can be used during configuration without entering the mac-address argument. The Cisco CME system detects MAC addresses and automatically populates phone configurations with their corresponding MAC addresses and phone types. This capability is not supported for voice-mail ports and is supported only by Cisco CME 3.0 and later versions. To use this capability, enable Cisco CME by using the following commands: max-ephones, max-dn, create cnf-files, and ip source-address. After these commands have been used, phones can start to register. Then, when you are configuring a registered ephone and you use the mac-address command with no argument, the MAC address of the phone is automatically read into the configuration. The equivalent functionality is available through the Cisco CME graphic user interface (GUI).

If you choose to configure phones before registering them, the MAC address for each ephone must be entered during configuration.

Examples

The following example associates the MAC address CFBA.321B.96FA with the IP phone that has phone-tag 22:

Related Commands


Command	Description
create cnf-files	Builds the XML configuration files that are required for IP phones used with Cisco IOS Telephony Services V2.1, Cisco CallManager Express 3.0, or later versions.
ephone	Enters ephone configuration mode.
ip source-address	Identifies the IP address and port through which IP phones communicate with a Cisco CME router.
max-dn	Sets the maximum number of ephone-dns to be supported by a Cisco CME router.
max-ephones	Sets the maximum number of ephones to be supported by a Cisco CME router.
show ephone registered	Displays status and information for registered IP phones.

mailbox-selection (dial-peer)

To set a policy for selecting a mailbox for calls from a Cisco Unified CME system that are diverted before being sent to a Cisco Unity Express or PBX voice-mail pilot number, use the mailbox-selection command in dial-peer configuration mode. To return to the default, use the no form of this command.

Syntax Description


last-redirect-num	(PBX voice mail only) The mailbox to which the call will be sent is the number that diverted the call to the voice-mail pilot number (the last number to divert the call).
orig-called-num	(Cisco Unity Express only) The mailbox to which the call will be sent is the number that was originally dialed before the call was diverted.

Command Default

Cisco Unity Express uses the last number to which the call was diverted before it was sent to voice mail as the mailbox number. Some legacy PBX systems use the originally called number as the mailbox number.

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4()T.

Usage Guidelines

When Cisco Unified CME diverts a call, it captures the reroute information which will be used to compose a reroute request. A dial-peer match will be performed against the diverted-to number. If this is the voice mail pilot number and the mailbox-selection command has been used to install a policy, the reroute information will be amended as directed by the command. The originator will pick up the modified reroute request, build the diversion information and include it in the new diverted call to the voice-mail pilot number.

This command should be used on the outbound dial peer for the pilot number of the voice-mail system.

This command might not work properly in certain network topologies, including the following cases:

•

When the last redirecting endpoint is not hosted on Cisco Unified CME. This may rarely occur with a PBX.

•

When a call is forwarded across several SIP trunks. Multiple SIP Diversion Headers (stacking hierarchy) are not supported in Cisco IOS software.

•

When a call is forwarded across non Cisco voice gateways that do not support the optional H450.3 originalCalledNr field.

Examples

The following example shows how to set a policy to select the mailbox of the originally called number when a call is diverted to a Cisco Unity Express or PBX voice-mail system with the pilot number 7000.

mailbox-selection (ephone-dn)

To set a policy for selecting a mailbox for calls that are diverted before being sent to a Cisco Unity voice-mail pilot number, use the mailbox-selection command in ephone-dn configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

last-redirect-num	The mailbox to which the call will be sent is the last number to divert the call.


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

This command is used on the ephone-dn associated with the voice-mail pilot number.

This command might not work properly in certain network topologies, including the following cases:

•

When the last redirecting endpoint is not hosted on Cisco Unified CME. This may rarely occur with a PBX.

•

When a call is forwarded across several SIP trunks. Multiple SIP Diversion Headers (stacking hierarchy) are not supported in Cisco IOS software.

•

When a call is forwarded across non Cisco voice gateways that do not support the optional H450.3 originalCalledNr field.

Examples

The following example sets a policy to select the mailbox of the last redirecting number when a call is diverted to a Cisco Unity voice-mail system with the pilot number 8000.

max-conferences

To set the maximum number of three-party conferences that are supported simultaneously by the Cisco CallManager Express (Cisco CME) router, use the max-conferences command in telephony-service configuration mode. To reset this number to the default, use the no form of this command.

Syntax Description


max-conference number	Maximum number of three-party conferences that are supported simultaneously by the router. This number is platform-dependent, and the default is half the maximum for each platform. The following are the maximum values for this argument: •Cisco 1700 series, Cisco 2600 series, Cisco 2801—8 •Cisco 2811, Cisco 2821, Cisco 2851, Cisco 3600 series, Cisco 3700 series—16 •Cisco 3800 series—24 (requires Cisco IOS Release 12.3(11)XL or higher) Note Each individual Cisco IP phone can host a maximum of one conference at a time. You cannot create a second conference on the phone if you already have an existing conference on hold.
gain	(Optional) Increases the sound volume of VoIP and public switched telephony network (PSTN) parties joining a conference call. The allowable decibel units are -6 db, 0 db, 3 db, and 6 db. The default is -6 db.

Defaults

Half the maximum number of simultaneous three-party conferences for each platform

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T	Cisco ITS 2.01	This command was implemented on the Cisco 1760.
12.3(11)XL1	Cisco CME 3.2.1	The gain keyword was added.
12.3(14)T	Cisco CME 3.3	This command was integrated into Cisco IOS Release 12.3(14)T.

Usage Guidelines

This command supports three-party conferences for local and on-net calls only when all conference participants are using the G.711 codec. Conversion between G.711 mu-law and A-law is supported. Mixing of the media streams is supported by the Cisco IOS processor. The maximum number of simultaneous conferences is limited to the platform-specific maximums.

The gain keyword's functionality is applied to inbound audio packets, so conference participants can more clearly hear a remote PSTN or VoIP caller joining their call. Note that this functionality cannot discriminate between a remote VoIP/foreign exchange office (FXO) source, which requires a volume gain, and a remote VoIP/IP phone, which does not require a volume gain and may therefore incur some sound distortions.

Examples

The following example sets the maximum number of conferences for a Cisco IP phone to 4 and configures a gain of 6 db for inbound audio packets from remote PSTN or VoIP calls joining a conference:

Related Commands

max-dn

Command	Description
telephony-service	Enters telephony-service configuration mode.

To set the maximum number of extensions (ephone-dns) to be supported by a Cisco Unified CME router, use the max-dn command in telephony-service configuration mode. To reset this number to the default value, use the no form of this command.

max-dn max-directory-numbers [preference preference-order] [no-reg {primary | both}]

Syntax Description


max-directory-numbers	Maximum number of extensions (ephone-dns) to allow in the Cisco CME system. The maximum you can set depends on the software version, router platform, and amount of memory that you have installed. Type ? to display range. The default is 0.
preference preference-order	(Optional) Sets a preference value for the primary number of an ephone-dn. Refer to CLI help for a range of numeric options, where 0 is the highest preference. Default is 0.
no-reg	(Optional) Globally disables ephone registration with an H.323 gatekeeper or SIP proxy.
primary	Primary ephone-dn numbers only.
both	Both primary and secondary ephone-dn numbers.

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.1(5)YD	Cisco ITS 1.0	This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT	Cisco ITS 2.0	This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T	Cisco ITS 2.01	This command was implemented on the Cisco 1760.
12.4(4)XC	Cisco Unified 4.0	The preference, no-reg, primary, and both keywords were introduced.
12.4(9)T	Cisco Unified 4.0	The preference, no-reg, primary, and both keywords were integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

The max-dn command limits the number of extensions (ephone-dns) available in a Cisco Unified CME system. The maximum number of ephone-dns that you can create depends on the software version, router platform, and amount of memory that you have installed. For the maximum number of ephone-dns and recommended memory for each platform, see the Cisco CallManager Express Supported Firmware, Platforms, Memory, and Voice Products for your Cisco Unified CME version.

The max-ephones command similarly limits the number of IP phones in a Cisco Unified CME system.

Note You can increase the number of allowable extensions to the maximum; but after the maximum allowable number is configured, you cannot reduce the limit without rebooting the router.

If registration with an H.323 gatekeeper or SIP proxy is enabled globally (the default), you can override the setting per extension by using the no-reg keyword in the number command for individual ephone-dns.

After using this command, you can provision individual extensions using the Cisco Unified CME graphic user interface (GUI) or the router CLI in ephone-dn configuration mode.

Examples

The following example sets the maximum number of extensions to 150 and specifies that the primary number of each extension should receive a dial-peer preference order of 1:

The following example sets the maximum number of extensions to 200 and specifies that they should not register both primary and secondary numbers with the H.323 gatekeeper:

The following example sets the maximum number of extensions to 200 and specifies that ephone-dn 36 should not register its primary number with the gatekeeper:

Related Commands


Command	Description
ephone-dn	Enters ephone-dn configuration mode.
max-ephones	Sets the maximum number of phones supported by the router.
number	Associates a telephone or extension number with an ephone-dn.
telephony-service	Enters telephony-service configuration mode.

max-dn (voice register global)

To set the maximum number of SIP phone directory numbers (extensions) that are supported by a Cisco CallManager Express (Cisco CME) router, use the max-dn command in voice register global configuration mode. To reset to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

max-directory-numbers	Maximum number of extensions (ephone-dns) supported by the Cisco router. The maximum number is version and platform dependent; type ? to display range. Range is 1 to 150. Default is 150.

Cisco IOS Release	Cisco Product	Modification
12.4(4)T	Cisco CME 3.4 Cisco SIP SRST 3.4	This command was introduced.

This command limits the number of SIP phone directory numbers (extensions) available in a Cisco CME system. The max-dn command is platform specific. It defines the limit for the voice register dn command. The max-pool command similarly limits the number of SIP phones in a Cisco CME system.

You can increase the number of allowable extensions to the maximum; but after the maximum allowable number is configured, you cannot reduce the limit without rebooting the router.

Examples

The following example shows how to set the maximum number of directory numbers to 48:

Related Commands


Command	Description
voice register dn	Enters voice register dn configuration mode to define an extension for a SIP phone line.
max-pool (voice register global)	Sets the maximum number of SIP voice register pools that are supported in a Cisco SIP SRST or Cisco CME environment.
voice register global	Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.

max-ephones

To set the maximum number of Cisco IP phones to be supported by a Cisco CallManager Express (Cisco CME) router, use the max-ephones command in telephony-service configuration mode. To reset this number to the default value, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

max-phones	Maximum number of phones supported by the Cisco CME router. The maximum number is version- and platform-dependent; refer to Cisco IOS command-line interface (CLI) help. Default is 0.


Cisco IOS Release	Cisco Product	Modification
12.1(5)YD	Cisco ITS 1.0	This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT	Cisco ITS 2.0	This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.

Usage Guidelines

The max-ephones command limits the number of Cisco IP phones supported on the router. The maximum number you can set is platform- and version-dependent. Use CLI help to determine the maximum number of ephones you can set, as shown in this example:

The max-dn command similarly limits the number of extensions (ephone-dns) in a Cisco CME system.

Note You can increase the number of phones; but after the maximum allowable number is configured, you cannot reduce the limit of the Cisco IP phones without rebooting the router.

After using this command, configure phones by using the Cisco CME graphic user interface (GUI) or the router CLI in ephone configuration mode.

Examples

The following example sets the maximum number of Cisco IP phones in a Cisco CME system to 24:

Related Commands


Command	Description
ephone	Enters ephone configuration mode.
max-dn	Sets the maximum number of extensions (ephone-dns) that can be supported by the router.
telephony-service	Enters telephony-service configuration mode.

maximum bit-rate (telephony-video)

To set the maximum IP phone video bandwidth, use the maximum bit-rate command in telephony-video configuration mode. To restore the default maximum bit-rate, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

value	Sets the maximum IP phone video bandwidth, in kbps. The range is 0 to 10000000. The default value is 10000000.


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Use this command to set the maximum bit-rate for all video-capable phones associated with a Cisco Unified CME router.

Examples

Related Commands

max-pool (voice register global)

Command	Description
maximum bit-rate (cm-fallback-video)	Sets the maximum bit-rate for all video-capable phones in a Cisco Unified SRST system.

To set the maximum number of Session Initiation Protocol (SIP) voice register pools that are supported in a Cisco Unified SIP Survivable Remote Site Telephony (SRST) or Cisco Unified CallManager Express (Cisco Unified CME) environment, use the max-pool command in voice register global configuration mode. To reset the maximum number to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

max-voice-register-pools	Maximum number of SIP voice register pools supported by the Cisco router. The upper limit of voice register pools is version- and platform-dependent; type ? for range. Default is 0.

Cisco IOS Release	Cisco Product	Modification
12.4(4)T	Cisco CME 3.4 Cisco SIP SRST 3.4	This command was introduced.

This command limits the number of SIP phones supported by a Cisco Unified CME or Cisco Unified SIP SRST environment. The max-pool command is platform specific and defines the limit for the voice register pool command. The max-dn command similarly limits the number of directory numbers (extensions) in a Cisco Unified CME system.

Note You can increase the number of phones; but after the maximum allowable number is configured, you cannot reduce the limit of the SIP phones without rebooting the router.

Examples

The following example shows how to set the maximum number of Cisco SIP IP phones in a Cisco Unified SIP SRST or Cisco Unified CME environment to 24:

Related Commands

max-redirect

Command	Description
max-dn (voice register global)	Set the maximum number of SIP phone directory numbers (extensions) that are supported by a Cisco Unified CME router.

To change the number of times that a call can be redirected by call forwarding or transfer within a Cisco CallManager Express (Cisco CME) system, use the max-redirect command in telephony-service configuration mode. To revert to the default number of redirects, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

number	Number of permissible redirects. Range is from 5 to 20. Default is 5.


Cisco IOS Release	Cisco Product	Modification
12.2(15)ZJ	Cisco CME 3.0	This command was introduced.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.

Usage Guidelines

This command supports Cisco CME ephone hunt groups by allowing calls to be redirected more than the default 5 times.

Examples

Related Commands

max-subscription

Command	Description
telephony-service	Enters telephony-service configuration mode.

To set the maximum number of concurrent watch sessions that are allowed, use the max-subscription command in presence configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

This command sets the maximum number of concurrent presence subscriptions for both internal and external subscribe requests.

Examples

Related Commands

number	Maximum watch sessions. Range: 100 to 500. Default: 100.

Release	Modification
12.4(11)XJ	This command was introduced.
12.4(15)T	This command was integrated into Cisco IOS Release 12.4(15)T.


Command	Description
allow watch	Allows a directory number on a phone registered to Cisco Unified CME to be watched in a presence service.
allow subscribe	Allows internal watchers to monitor external presence entities (directory numbers).
presence	Enables presence service on the router and enters presence configuration mode.
presence enable	Allows incoming presence requests from SIP trunks.
server	Specifies the IP address of a presence server for sending presence requests from internal watchers to external presence entities.
watcher all	Allows external watchers to monitor internal presence entities (directory numbers).

max-timeout

To set the maximum combined timeout for the no-answer periods for all ephone-dns in the ephone-hunt list, use the max-timeout command in ephone-hunt configuration mode. To return this value to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

seconds	Number of seconds. Range is from 3 to 60000. Default is unlimited.


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Examples

The following example shows how to set different no-answer timeouts for each ephone-dn in the hunt-group list and no maximum timeout. The first call to the hunt group rings extension 1001. If that extension does not answer in 7 seconds, the call is forwarded to extension 1002. If that extension does not answer after 10 seconds, the call is forwarded to extension 1003. However, if extension 1003 does not answer after 8 seconds, the call is sent to the final number, extension 4500, because the maximum timeout of 25 seconds has been reached.

Related Commands

mode (voice register global)

Command	Description
ephone-hunt	Defines an ephone hunt group and enters ephone-hunt configuration mode.

To enable the mode for configuring SIP phones in a Cisco Unified CallManager Express (Cisco Unified CME) system, use the mode cme command in voice register global configuration mode. To return to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

This command enables Cisco Unified CME on the router for configuration purposes. The router is enabled for Cisco SIP SRST by default. Enable this command before configuring SIP phones in Cisco Unified CME to ensure that all required commands are available.

Examples

Related Commands

moh (ephone-dn)

cme	Only valid keyword is cme. This mode determines the commands that are available to configure SIP phones.

Cisco IOS Release	Cisco Product	Modification
12.4(4)T	Cisco CME 3.4	This command was introduced.

Command	Description
show voice register global	Displays all global configuration information associated with SIP phones.

To enable music on hold (MOH) from an external live audio feed (standard line-level audio connection) connected directly to the router by an foreign office exchange (FXO) or an E&M analog voice port, use the moh command in ephone-dn configuration mode. To disable MOH from a live feed or to disable the outcall number or multicast capability, use the no form of this command.

moh [out-call outcall-number] [ip ip-address port port-number [route ip-address]]

Syntax Description


out-call outcall-number	(Optional) Sets up a call to the outcall number in order to connect to the MOH feed. If this keyword is not used, the live feed is assumed to derive from an incoming call to the ephone-dn under which this command is used.
ip ip-address	(Optional) Indicates that this audio stream is to be used as a multicast source as well as the MOH source and specifies the destination IP address for multicast.
port port-number	(Optional) Specifies the media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because this port is already used for normal Real-Time Transport Protocol (RTP) media transmissions between IP phones and the Cisco CallManager Express router.
route ip-address	(Optional) Indicates the specific router interface on which to transmit the IP multicast packets. The default is that the MOH multicast stream is automatically output on the interface that corresponds to the address that was configured with the ip source-address command.

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(11)YT	Cisco ITS 2.1	This command was introduced.
12.2(15)T	Cisco ITS 2.1	This command was integrated into Cisco IOS Release 12.2(15)T.
12.2(15)ZJ	Cisco CME 3.0	The ip, port, and route keywords were added.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.

Usage Guidelines

This command takes the specified live-feed audio stream and uses it as MOH for a Cisco CallManager Express (CME) system. The connection for the live-feed audio stream is established as an automatically connected voice call. If the out-call keyword is used, the type of connection can include VoIP calls if voice activity detection (VAD) is disabled. The typical operation is for the MOH ephone-dn to establish a call to a local router E&M voice port.

Connection via E&M is the recommended mechanism because it requires minimal external components. The E&M port must be placed in 4-wire operation, using E&M immediate signaling and with the auto-cut-through option enabled. You directly connect a line-level audio feed (standard audio jack) to pins 3 and 6 of an E&M RJ-45 connector. The E&M WAN interface card (WIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. (The audio connection on the E&M port does not require loop current.) The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by the digital signal processor (DSP) on the E&M port.

If you are using an FXO voice port for live-feed MOH instead of an E&M port, connect the MOH source to the FXO voice port. This connection requires an external adapter to supply normal telephone company (telco) battery voltage with the correct polarity to the tip-and-ring leads of the FXO port. The adapter must also provide transformer-based isolation between the external audio source and the tip-and-ring leads of the FXO port.

Music from a live feed is continuously fed into the MOH playout buffer instead of being read from an audio file in flash memory. There is typically a two-second delay with live-feed MOH.

If the out-call keyword is used, an outbound call to the MOH live-feed source is attempted (or reattempted) every 30 seconds until the call is connected to the ephone-dn (extension) that has been configured for MOH. Note that this ephone-dn is not associated with any physical phone.

If the moh (ephone-dn) command is used without any keywords or arguments, the ephone-dn will accept an incoming call and use the audio stream from the call as the source for the MOH stream, displacing any audio stream that is available from a flash file. To accept an incoming call, the ephone-dn must have an extension or phone number configured for it. A typical usage would be for an external H.323-based server device to call the ephone-dn to deliver an audio stream to the Cisco CME system. Normally, only a single ephone-dn would be configured like this. If there is more than one ephone configured to accept incoming calls for MOH, the first ephone-dn that is successfully connected to a call (incoming or outgoing) is the MOH source for the system.

MOH can also be derived from an audio file when you use the moh command in telephony-service configuration mode with the filename argument. There can be only one MOH stream at a time in a Cisco CME system, and if both an audio file and a live feed have been specified for the MOH stream, the router seeks the live feed from the moh (ephone-dn) command first. If the live feed is found, the router displaces the audio file source. If the live feed is not found or fails at any time, the router falls back to the audio file source that was specified in the moh (telephony-service) command.

If you use the ip keyword to specify a multicast address in this command, the audio stream is sent to the multicast address in addition to serving as the MOH source. Additionally, if you specify a different multicast address using the multicast moh command under telephony-service configuration mode, the audio stream is also sent to the multicast address that you named in that command. It is therefore possible to send the live-feed audio stream to MOH and to two different multicast addresses: the one that is directly configured under the moh (ephone-dn) command and the one that is indirectly configured under the multicast moh (telephony-service) command.

A related command, the feed command, provides the ability to multicast an audio stream that is not the MOH audio stream.

Examples

The following example establishes a live music-on-hold source by setting up a call to extension 7777:

Related Commands


Command	Description
auto-cut-through	Enables call completion when an M-lead response is not provided.
ephone-dn	Enters ephone-dn configuration mode to set directory numbers and parameters for individual Cisco IP phone extensions.
feed	Enables multicast of an audio stream that is different from the music-on-hold audio stream.
ip source-address	Identifies the IP address and port through which IP phones communicate with a Cisco CME router.
moh (telephony-service)	Enables music on hold from an audio file.
multicast moh	Enables multicast of the music-on-hold audio stream.
signal	Specifies the type of signaling for a voice port.

moh (telephony-service)

To generate an audio stream from a file for music on hold (MOH) in a Cisco CallManager Express (Cisco CME) system, use the moh command in telephony-service configuration mode. To disable the MOH audio stream from this file, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

filename	Name of the audio file to use for the MOH audio stream. The file must be copied to flash memory on the Cisco CME router.


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.

Usage Guidelines

This command enables MOH from .au and .wav format music files. MOH is played for G.711 callers and on-net VoIP and PSTN callers who are on hold in a Cisco CME system. Local callers within a Cisco CME system hear a repeating tone while they are on hold.

Audio files that are used for MOH must be copied to the Cisco CME router flash memory. A MOH file can be in .au or .wav file format; however, the file format must contain 8-bit 8-kHz data in A-law or mu-law data format.

If you want to replace or modify the audio file that is currently specified, you must first disable the MOH capability using the no moh command. The following example replaces file1 with file2:

If you specify a second file without first removing the original file, the MOH mechanism stops working and may require a router reboot to clear the problem.

A related command, the moh command in ephone-dn configuration mode, can be used to establish a MOH audio stream from a live feed. If you configure both commands, MOH falls back to playing music from the audio file if the live music feed is interrupted.

The multicast moh command allows you to use the MOH stream for a multicast broadcast.

When the multicast moh and debug ephone moh commands are both enabled, if you also use the no moh command, the debug output can be excessive and flood the console. Multicast MOH should be disabled before using the no moh command when the debug ephone moh command is enabled.

Examples

Related Commands


Command	Description
debug ephone moh	Displays diagnostic information for music on hold.
moh (ephone-dn)	Enables music on hold from a live audio feed.
multicast moh	Enables multicast of the music-on-hold audio stream.
telephony-service	Enters telephony-service configuration mode.

mtp

To send media packets from an IP phone to the Cisco Unified CME router, use the mtp command in ephone or ephone-template configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

An IP phone in a call with another IP phone in the same Cisco Unified CME system sends media packets directly to the other phone.

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Normally, media packets (RTP) packets that are sent between IP phones in the same Cisco Unified CME system go directly to the other phone and do not travel through the Cisco Unified CME router. When these packets are sent from a remote IP phone to another IP phone in the same Cisco Unified CME system, they may be obstructed by a firewall. The mtp command instructs a phone to always send its media packets to the Cisco Unified CME router, which acts as a proxy and forwards the packets to the destination. Firewalls can then be easily configured to pass the RTP packets because the router uses a specified UDP port for media packets. In this way, RTP packets from remote IP phones can be delivered to IP phones on the same system. The default is that this function is off and that RTP packets that are sent from one IP phone to another IP phone in the same Cisco Unified CME system go directly to the other phone.

If you use an ephone template to apply a command to a phone and you also use the same command in ephone configuration mode for the same phone, the value that you set in ephone configuration mode has priority.

Examples

The following example sends media packets from ephone 437 to the Cisco Unified CME router for all calls:

multicast moh

To use the music-on-hold (MOH) audio stream as a multicast source in a Cisco CME system, use the multicast moh command in telephony-service configuration mode. To disable multicast use of the MOH stream, use the no form of this command.

multicast moh ip-address port port-number [route ip-address-list]

Syntax Description


ip-address	Specifies the destination IP address for multicast.
port port-number	Specifies the media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because this port is already used for normal Real-Time Transport Protocol (RTP) media transmissions between IP phones and the Cisco CME router.
route ip-address-list	(Optional) Indicates specific router interfaces over which to transmit the IP multicast packets. Up to four IP addresses can be listed, each separated from the other by a space. The default is that the MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command.

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(15)ZJ	Cisco CME 3.0	This command was introduced.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.

Usage Guidelines

This command enables multicast of the audio stream that is designated for MOH in a Cisco CME system. A related command, the moh (ephone-dn) command, creates a MOH audio stream from an external live feed and optionally enables multicast on that stream. These two commands can be used concurrently to provide multicast of a live-feed MOH audio stream to two different multicast addresses.

Another related command, the feed command, enables multicast of an audio stream that is not the MOH audio stream.

Examples

The following example enables multicast of the MOH audio stream at multicast address 239.10.16.4 and names two router interfaces over which to send the multicast packets.

Related Commands


Command	Description
feed	Enables multicast of an audio stream that is not the music-on-hold audio stream.
ip source-address	Identifies the IP address and port through which IP phones communicate with a Cisco CME router.
moh (ephone-dn)	Enables music on hold from a live audio feed.
moh (telephony-service)	Enables music on hold from an audio file.
telephony-service	Enters telephony-service configuration mode.

multicast-moh

To enable multicast music on hold (MOH) on a phone in a Cisco Unified CME system, use the multicast-moh command in ephone or ephone-template configuration mode. To disable multicast MOH per phone, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

The no form of this command is used to disable multicast MOH for phone types that do not support IP multicast and therefore do not support multicast MOH.

Examples

The following example shows how to use an ephone template to disable multicast MOH for ephone 2:

Related Commands

mwi (ephone-dn and ephone-dn-template)

Command	Description
multicast moh	Enables multicast of the music-on-hold audio stream.

To enable a specific Cisco Unified IP phone extension (ephone-dn) to receive message-waiting indication (MWI) notification from an external voice-messaging system, use the mwi command in ephone-dn or ephone-dn-template configuration mode. To disable this feature, use the no form of this command.

Syntax Description


off	Sets a Cisco Unified IP phone extension to process MWI to OFF, using either the main or secondary phone number.
on	Sets a Cisco Unified IP phone extension to process MWI to ON, using either the main or secondary phone number.
on-off	Sets a Cisco Unified IP phone extension to process MWI to both ON and OFF, using either the main or secondary phone number.

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.4(4)XC	Cisco Unified CME 4.0	This command was made available in ephone-dn-template configuration mode.
12.4(9)T	Cisco Unified CME 4.0	This command in ephone-dn-template configuration mode was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

This command enables a Cisco Unified IP phone extension to receive MWI notification from an external voice-messaging system for all the Cisco Unified IP phones connected to the Cisco Unified CME router. This extension is a "dummy" extension and is not associated with any physical phone. The external voice-messaging system is able to communicate MWI status by making telephone calls to the dummy extension number, with the MWI information embedded in either the called or calling-party IP phone number.

This command cannot be used unless the number command is already configured for this extension (ephone-dn).

If you use an ephone-dn template to apply a command to an ephone-dn and you also use the same command in ephone-dn configuration mode for the same ephone-dn, the value that you set in ephone-dn configuration mode has priority.

Examples

The following example sets MWI to both on and off for the primary and secondary number, where the MWI information is embedded in the calling-party number. A call placed by the voice-mail system to 8002 turns on the MWI light for the extension number indicated by the calling-party number for the MWI call. A call placed to 8003 turns off the MWI light.

The following example sets MWI to both on and off for the primary and secondary number, where the MWI information is embedded in the called-party number. A call placed by the voice-mail system to 8000*5001*1 turns on the MWI light for extension 5001. A call placed to 8000*5001*2 turns off the MWI light.

Related Commands


Command	Description
ephone-dn	Enters ephone-dn configuration mode.
mwi expires	Sets the expiration timer for registration for either the client or the server.
mwi sip (ephone-dn)	Subscribes an extension in a Cisco Unified CME router to receive MWI notification from a SIP MWI server.
mwi sip-server (telephony-service)	Configures the IP address and port number for an external SIP-based MWI server.
number	Associates a telephone or extension number with an extension (ephone-dn) in a Cisco Unified CME system.

mwi (voice register dn)

To enable a specific Cisco IP phone extension (ephone-dn) using a SIP phone to receive message-waiting indication (MWI) notification, use the mwi command in voice register dn configuration mode. To return to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Examples

Related CommandsRouter(config-register-dn)# number 1001

mwi expires

To set the expiration timer for registration for the message-waiting indication (MWI) client or server, use the mwi expires command in telephony-service configuration mode. To disable the timer, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.

Examples

Related Commands


Command	Description
mwi relay (telephony-service)	Enables the Cisco CME router to relay MWI information to remote Cisco IP phones.
mwi sip-server (telephony-service)	Configures the IP address and port number for the external SIP-based MWI server.
telephony-service	Enters telephony-service configuration mode.

mwi prefix

To specify a prefix for an extension that will receive unsolicited message-waiting indication (MWI) from an external SIP-based MWI server, use the mwi prefix command in telephony-service configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Central voice-messaging servers that provide mailboxes for several Cisco Unified CME sites may use site codes or prefixes to distinguish among similarly numbered ranges of extensions at different sites. In Cisco Unified CME 4.0 and later versions, you can specify that your Cisco Unified CME system should accept unsolicited SIP Notify messages for message-waiting indication (MWI) that include a prefix string as a site identifier.

For example, an MWI message might indicate that the central mailbox number 5551234 has a voice message. In this example, the digits 555 are set as the prefix string or site identifier using the mwi prefix command. The local Cisco Unified CME system is able to convert 5551234 to 1234 and deliver the MWI to the correct phone. Without this prefix string manipulation, the system would reject an MWI indication for 5551234 as not matching the local Cisco Unified CME extension 1234.

Examples

The following example identifies the SIP server for MWI notification at the IP address 172.16.14.22. It states that the Cisco Unified CME system will accept unsolicited SIP Notify messages for known mailbox numbers (extension numbers) that are prefixed with the digits 555.

Related Commands


Command	Description
mwi (ephone-dn)	Configures specific Cisco Unified IP phone directory numbers to receive MWI notification from an external voice-mail system.
mwi-server	Configures MWI server parameters.
mwi sip (ephone-dn)	Subscribes an extension in a Cisco Unified CME router to receive MWI notification from a SIP MWI server.
telephony-service	Enters telephony-service configuration mode.

mwi qsig

To enable Cisco Unified CME to interrogate a QSIG message center for the message-waiting indication (MWI) status of an IP phone extension, use the mwi qsig command in ephone-dn or ephone-dn-template configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

The transfer-system command must be used with the full-consult or full-blind keyword to enable H.450 call forwarding.

Examples

In the following example, a voice mail extension (7000) and a normal extension (7582) are defined. Calls are forwarded to voice mail when extension 7582 is busy or does not answer. The message-waiting indicator (MWI) on extension 7582's phone is subscribed to receive notifications from the QSIG message center.

Related Commands


Command	Description
transfer-system	Specifies the call transfer method for Cisco Unified CME extensions.
voicemail	Defines the telephone number that is speed-dialed when the Messages button on a Cisco Unified IP phone is pressed.

mwi reg-e164

To register E.164 numbers rather than extension numbers with a Session Interface Protocol (SIP) proxy or registrar, use the mwi reg-e164 command in telephony-service configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

This command is used when setting up extensions to use an external SIP-based message-waiting indication (MWI) server. The mwi-server command in SIP user-agent configuration mode specifies other settings for MWI service.

Examples

The following example specifies that E.164 numbers should be used for registration with the SIP proxy or registrar:

Related Commands

mwi reg-e164 (voice register global)

To configure a gateway to register or deregister a fully-qualified dial-peer E.164 address with a gatekeeper, use the mwi reg-164 command in voice register global configuration mode. To return to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Examples

Related Commands

mwi relay

To enable a Cisco CallManager Express (Cisco CME) router to relay message-waiting indication (MWI) notification to remote Cisco IP phones, use the mwi relay command in telephony-service configuration mode. To disable MWI relay, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.

Usage Guidelines

Use this command to enable the Cisco CME router to relay MWI notification to remote Cisco IP phones. The router at the central site acts as a notifier after this command is used.

Examples

Related Commands


Command	Description
mwi expires	Sets the expiration timer for registration for the client or the server.
show mwi relay clients	Displays registration information for MWI relay clients.
telephony-service	Enters telephony-service configuration mode.

mwi sip

To subscribe an extension in a Cisco Unified CME system to receive message-waiting indication (MWI) from a SIP-based MWI server, use the mwi sip command in ephone-dn or ephone-dn-template configuration mode. To remove the configuration, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.4(4)XC	Cisco Unified CME 4.0	This command was made available in ephone-dn-template configuration mode.
12.4(9)T	Cisco Unified CME 4.0	This command in ephone-dn-template configuration mode was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Use this command to subscribe an extension in a Cisco Unified CME router to receive MWI notification from a SIP-based MWI server, and use the mwi sip-server command to specify the IP address and port number for the external SIP-based MWI server. This function integrates a Cisco Unified CME router with a SIP-protocol-based MWI service.

Examples

The following example subscribes extension 5001 to receive MWI notification from an external Session Initiation Protocol (SIP) MWI server and requests the SIP MWI server to send MWI notification messages through SIP to the Cisco Unified CME router for extension 5001:

Related Commands


Command	Description
ephone-dn	Enters ephone-dn configuration mode.
ephone-dn-template	Enters ephone-dn-template configuration mode.
mwi sip-server (telephony-service)	Configures the IP address and port number for the external SIP-based MWI server.
show mwi relay clients	Displays registration information for MWI relay clients.

mwi sip-server

To configure parameters associated with an external SIP-based message-waiting indication (MWI) server, use the mwi sip-server command in telephony-service configuration mode. To disable MWI server functionality, use the no form of this command.

mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited [prefix prefix-string]]

no mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited [prefix prefix-string]]

Syntax Description


ip-address	IP address of the MWI server.
transport tcp	(Optional) Selects TCP as the transport layer protocol. This is the default transport protocol.
transport udp	(Optional) Selects UDP as the transport layer protocol. The default if these keywords are not used is TCP.
port port-number	(Optional) Specifies port number for the MWI server. Range is from 2000 to 9999. Default is 5060 (SIP standard port).
reg-e164	(Optional) Registers an E.164 number with a Session Interface Protocol (SIP) proxy or registrar rather than an extension number. Registering with an extension number is the default.
unsolicited	(Optional) Sends SIP Notify message for MWI without any need to send a Subscribe message from the Cisco Unified CME router.
prefix prefix-string	(Optional) Allows the specified digits to be present before a recognized Cisco Unified CME extension number. The maximum prefix length is 32 digits.

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.2(2)XT	Cisco ITS 2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(15)ZJ	Cisco CME 3.0	The unsolicited keyword was added.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.
12.4(4)XC	Cisco Unified CME 4.0	The prefix prefix-string keyword-argument pair was added.
12.4(9)T	Cisco Unified CME 4.0	The prefix prefix-string keyword-argument pair was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Use this command to configure the IP address of an external SIP MWI server. This IP address is used with the mwi sip (ephone-dn) command to subscribe individual ephone-dn extension numbers to the notification list of the MWI SIP server. A SIP MWI client runs TCP by default.

The transport tcp keyword is the default setting. The transport udp keyword allows you to integrate with a SIP MWI client. The optional port keyword is used to specify a port number other than 5060, the default. The default registration is with an extension number, so the reg-e164 keyword allows you to register with an E.164 ten-digit number.

Central voice-messaging servers that provide mailboxes for several Cisco Unified CME sites may use site codes or prefixes to distinguish among similarly numbered ranges of extensions at different sites. In Cisco CME 3.2.3 and later versions, you can specify that your Cisco Unified CME system should accept unsolicited SIP Notify messages for message-waiting indication (MWI) that include a prefix string as a site identifier.

Examples

The following example sets MWI for the SIP server and sets individual ephone-dn extension numbers to the MWI SIP server's notification list:

Related Commands


Command	Description
mwi (ephone-dn)	Configures specific Cisco Unified IP phone directory numbers to receive MWI notification from an external voice-mail system.
mwi expires	Sets the expiration timer for registration for the client or the server.
mwi sip (ephone-dn)	Subscribes an extension in a Cisco Unified CME router to receive MWI notification from a SIP MWI server.
show mwi relay clients	Displays the registration information for MWI relay clients.
telephony-service	Enters telephony-service configuration mode.

mwi stutter (voice register global)

To generate a stutter tone for message-waiting indication (MWI) in a Cisco CallManager Express (Cisco CME) system using SIP, use the mwi stutter command in voice register global configuration mode. To disable MWI stutter, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Use this command to enable the Cisco CME router to relay MWI notification to remote Cisco IP phones. The router at the central site acts as a notifier after this command is used.

Examples

Related Commands

mwi-line

To designate a line other than the primary line of an ephone to be associated with the ephone's message waiting indicator (MWI) lamp, use the mwi-line command in ephone configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

A phone's MWI lamp is lit only when there is a message waiting for the phone's primary line (line 1).

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

This command designates a phone line other than the primary line to activate the MWI lamp on the phone. When a message is waiting for an ephone-dn associated with the designated line, the MWI lamp is turned on. When the message is heard, the MWI lamp is turned off. For phone lines other than the line that is designated to receive MWI, an envelope icon is displayed next to them when there is a message waiting.

Note that a logical phone "line" is not the same as a phone button. A line is a button that has one or more ephone-dns assigned to it. A button that has no ephone-dns assigned to it does not count as a line. For examples of line numbers in different phone configurations, see the " Examples" section.

In most cases, one ephone-dn is assigned to one button on an ephone. When you set the mwi-line command to that button, the MWI lamp is turned on when there is a message waiting for that ephone-dn. When you set the mwi-line command to a button with a more complex configuration, the following rules apply:

•

When a button has a single ephone-dn with primary and secondary numbers, the MWI lamp is turned on only when there is a message waiting for the primary number.

•

When a button has several ephone-dns overlaid on it, the MWI lamp is turned on only when there is a message waiting for the first number in the list of ephone-dns.

•

When a button is an overflow button for an overlay button, the MWI lamp is not turned on for any extension that might overflow to this button. If you set the mwi-line command to this button, the command is ignored.

Examples

The following example enables MWI on ephone 18 for line 2 (button 2), which has overlaid ephone-dns. The MWI lamp on this phone will be lit only if there is a message waiting for extension 2021. Button 4 is unused. The line numbers in this example are as follows:

The following example enables MWI on ephone 17 for line 3 (extension 609). In this case, the button numbers do not match the line numbers because buttons 2 and 4 are not used.

mwi-type

To specify the type of message-waiting indication (MWI) notification that a directory number can receive and process, use the mwi-type command in ephone-dn or ephone-dn-template configuration mode. To disable this feature, use the no form of this command.

Syntax Description


visual	Sets a directory number to process visual MWI, using either the main or secondary phone number.
audio	Sets a directory number to process audible MWI (AMWI), using either the main or secondary phone number.
both	Sets a directory number to process both visual and audible MWI, using either the main or secondary phone number.

Command Default

If MWI is enabled for a directory number, directory number will receive visual MWI.

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(6)XE	Cisco Unified CME 4.0(2)	This command was introduced.
12.4(4)XC4	Cisco Unified CME 4.0(3)	This command was introduced.
12.4(11)T	Cisco Unified CME 4.0(3)	This command was integrated into Cisco IOS Release 12.4(11)T.

Usage Guidelines

This command enables a directory number to receive audible, visual, or both audible and visual MWI notification from an external voice-messaging system. The external voice-messaging system is able to communicate MWI status by making telephone calls to the dummy extension, with the MWI information embedded in either the called or calling-party IP phone number.

The Cisco Unified CME applies the following logic based on the capabilities of the IP phone and how the mwi-type command is configured:

•

If the phone supports (visual) MWI and MWI is configured for the phone, turn on the Message Waiting light

•

If the phone supports (visual) MWI only, turn on the Message Waiting light regardless of the configuration.

•

If the phone supports AMWI and AMWI is configured for the phone, send the stutter dial tone to the phone when it goes off-hook.

•

If the phone supports AMWI only and AMWI is configured, send the stutter dial tone to the phone when it goes off hook regardless of the configuration.

•

If a phone supports (visual) MWI and AMWI and both options are configured for the phone, turn on the Message Waiting light and send the stutter dial tone to the phone when it goes off-hook.

If you use an ephone-dn template to apply a command to a directory number and you also use the same command in ephone-dn configuration mode for the same number, the value that you set in ephone-dn configuration mode has priority.

Examples

The following example shows how to enable AMWI on extension 8000, assuming that the phone to which this directory number is assigned supports AMWI. Otherwise, a call placed by the voice-mail system to 8001 turns on the MWI light for the extension number indicated by the calling-party number for the MWI call.

The following example shows how to enable both audible and visual MWI. A call placed by the voice-mail system to 8001 turns on the MWI light for the extension number indicated by the calling-party number for the MWI call. When the phone user takes the phone off hook, they hear a stutter dial tone:

Related Commands


Command	Description
mwi (ephone and ephone template)	Enables a directory number to receive MWI.
number	Associates a telephone or extension number with a directory number in a Cisco Unified CME system.

Table Of Contents