|
|
Table Of Contents
call application voice aa-hunt
call application voice aa-name
call application voice aa-pilot
call application voice call-retry-timer
call application voice dial-by-extension-option
call application voice drop-through-option
call application voice drop-through-prompt
call application voice handoff-string
call application voice max-extension-length
call application voice max-time-call-retry
call application voice max-time-vm-retry
call application voice number-of-hunt-grps
call application voice queue-len
call application voice queue-manager-debugs
call application voice second-greeting-time
call application voice voice-mail
call application voice welcome-prompt
caller-id block (voice register template)
caller-id block code (telephony-service)
call-forward b2bua unreachable
call-waiting (voice register pool)
clear telephony-service ephone-attempted-registrations
clear telephony-service conference hardware number
clear telephony-service xml-event-log
conference (voice register template)
create profile (voice register global)
Cisco Unified CME Commands: C
Last Updated: July 19, 2007First Published: February 27, 2006
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.
call application voice aa-hunt
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice aa-hunt command is replaced by the param aa-hunt command. See the param aa-hunt command for more information.
To declare a Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) menu number and associate it with the pilot number of an ephone hunt group, use the call application voice aa-hunt command in global configuration mode. To remove the menu number and the ephone hunt group pilot number, use the no form of this command.
call application voice application-name aa-huntmenu-number pilot-number
no call application voice application-name aa-huntmenu-number pilot-number
Syntax Description
Command Default
Cisco CME B-ACD menu number 1 is configured, but it has no pilot number.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD call queue scripts. Up to three menu options are allowed per call queue script. You can use any of the allowable numbers in any order.
The call application voice aa-hunt command allows each of the menu options to be associated with the pilot number of an ephone hunt group. The menu options are announced by the en_bacd_options_menu.au audio file, which you can rerecord. When a caller presses a number, the call will go to the pilot number of an ephone hunt group so it can be transferred to one of the ephone hunt group's ephone-dns. It will not go to any other ephone hunt group. The order in which ephone-dns are selected depends on the ephone hunt group's search method, which is configured with the ephone-hunt command, and whether an ephone-dn is busy or not.
If only one menu option is configured, callers will hear a greeting and be transferred directly to the pilot number of the corresponding ephone hunt group. They do not have to enter a number.
The highest aa-hunt number will automatically be set to zero (0) for the operator. In the following example, aa-hunt8 supports the menu option of 0 and 8.
call application voice queue aa-hunt1 1111call application voice queue aa-hunt3 3333call application voice queue aa-hunt8 8888If a phone user presses 0 or 8, their call be sent to pilot number 3333.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example associates three menu numbers with three pilot numbers of three ephone hunt groups. Pilot number 1111 is for ephone hunt group 1 (sales); 2222 is for ephone hunt group 2 (customer service); and 3333 is for ephone hunt group 3 (operator). If sales is selected from the AA menu, the call will be transferred to 1111 and sent to ephone hunt group 1's available ephone-dns (2001, 2002, 2003, 2004, 2005, 2006).
Router(config)# ephone-hunt 1 peerRouter(config-ephone-hunt)# pilot 1111Router(config-ephone-hunt)# list 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010Router(config)# ephone-hunt 2 peerRouter(config-ephone-hunt)# pilot 2222Router(config-ephone-hunt)# list 2001, 2002, 2003, 2004, 2005, 2006Router(config)# ephone-hunt 3 peerRouter(config-ephone-hunt)# pilot 3333Router(config-ephone-hunt)# list 3001, 3002, 3003, 3004Router(config)# call application voice queue flash:app-b-acd-x.x.x.x.tcl
Router(config)# call application voice queue aa-hunt1 1111Router(config)# call application voice queue aa-hunt2 2222Router(config)# call application voice queue aa-hunt3 3333Related Commands
call application voice aa-name
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice aa-name command is not available in Cisco IOS software.
To associate the queue script for Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) with the Cisco CME B-ACD auto-attendant (AA) script, use the call application voice aa-name command in global configuration mode. To remove the queue script and AA script association, use the no form of this command.
call application voice application-name aa-name aa-script-name
no call application voice application-name aa-name aa-script-name
Syntax Description
application-name
Application name given to the call queue script in the call application voice command.
aa-script-name
Application name given to the AA script in the call application voice command.
Command Default
No call queue script and AA script association is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD call queue scripts. Only one AA script can be associated with one call queue script.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example associates a call queue script with an AA script:
Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice queue flash:app-b-acd-x.x.x.x.tcl
Router(config)# call application voice queue aa-name aaRelated Commands
call application voice aa-pilot
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice aa-pilot command is replaced by the param aa-pilot command. See the param aa-pilot command for more information.
To assign a pilot number to the Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) service, use the call application voice aa-pilot command in global configuration mode. To remove the Cisco CME B-ACD pilot number, use the no form of this command.
call application voice application-name aa-pilot pilot-number
no call application voice application-name aa-pilot pilot-number
Syntax Description
application-name
Application name given to the auto-attendant (AA) script in the call application voice command.
pilot-number
Pilot number for Cisco CME B-ACD.
Command Default
No Cisco CME B-ACD pilot number is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. Only one pilot number can be used for each Cisco CME B-ACD service, and the voice ports handling AA must have dial peers that will send calls to the pilot number.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example assigns 8005550100 as the pilot number to the Cisco CME B-ACD service. Included in this example is the dial-peer configuration for the pilot number.
Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa aa-pilot 8005550100Router(config)# dial-peer voice 1000 potsRouter(config)# incoming pilot number 8005550100Router(config)# application aaRouter(config)# direct-inward-dialRouter(config)# port 1/0:23Router(config)# forward digits-allRouter(config)# call application voice aa aa-pilot 80055501Related Commands
call application voice call-retry-timer
Effective with Cisco IOS Release 12.3(14)T and later, the call application call-retry-timer command is replaced by the param call-retry-timer command. See the param call-retry-timer command for more information.
To assign the length of time that calls to Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) must wait before attempting to transfer to an ephone hunt group pilot number, use the call application voice call-retry-timer command in global configuration mode. To remove the retry time, use the no form of this command.
call application voice application-name call-retry-timer seconds
no call application voice application-name call-retry-timer seconds
Syntax Description
Command Default
The retry interval is 15 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. The following sequence of events might occur:
•
An outside call comes into a system configured with Cisco CME B-ACD.
•
•
In that case, the call will wait in a queue for the period of time set by the call application voice call-retry-timer command and retry to the pilot number.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example shows a configuration that allows outside calls to Cisco CME B-ACD to retry an ephone hunt group pilot number every 30 seconds. The example shows the configuration for one ephone hunt group, which is presented by Cisco CME B-ACD menu as the sales department and uses a simple configuration. If a caller selects the sales menu option (ephone-hunt 1) and all of the ephone-dns configured in the list command (1001, 1002, 1003, 1004) are busy, the call will wait 30 seconds and then retry the pilot number (1111) until either an ephone-dn becomes available or a configured amount of time has elapsed (see the call application voice max-time-call-retry command).
Router(config)# ephone-hunt 1 peerRouter(config-ephone-hunt)# pilot 1111Router(config-ephone-hunt)# list 1001, 1002, 1003, 1004Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa call-retry-timer 30Related Commands
call application voice dial-by-extension-option
Effective with Cisco IOS Release 12.3(14)T and later, the call application dial-by-extension-option command is replaced by the param dial-by-extension-option command. See the param dial-by-extension-option command for more information.
To enable direct extension access and set the access number for Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD), use the call application voice dial-by-extension-option command in global configuration mode. To disable direct dial extension access and remove the access number, use the no form of this command.
call application voice application-name dial-by-extension number
no call application voice application-name dial-by-extension number
Syntax Description
Defaults
Direct dial access is disabled. No access number is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. It enables the en_bacd_enter_dest.au audio file. The default announcement says, "Please enter the extension number you want to reach." The call application voice dial-by-extension-option command also allows for the configuration of the number that callers must press before they can enter the extension number that they want to call.
Callers who select the extension access option can then dial any extension. If they dial an ephone hunt group ephone-dn or pilot number, their call will not be sent to the ephone hunt-group call queue.
Examples
The following example configures Cisco CME B-ACD to include an option that allows callers to press the number 4 so they can dial an extension number.
Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa dial-by-extension 4Related Commands
call application voice
Defines a name for a voice application and specifies the location of the Tcl or VoiceXML document to load for this application.
call application voice drop-through-option
Cisco IOS Release 12.3(14)T and later releases support Cisco CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) Tcl scripts version 2.1.0.0 and greater. In these releases, the call application voice drop-through-option command has been replaced by the param drop-through-option command.
call application voice drop-through-prompt
Cisco IOS Release 12.3(14)T and later releases support Cisco CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) Tcl scripts version 2.1.0.0 and greater. In these releases, the call application voice drop-through-prompt command has been replaced by the param drop-through-prompt command.
call application voice handoff-string
Cisco IOS Release 12.3(14)T and later releases support Cisco CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) Tcl scripts version 2.1.0.0 and greater. In these releases, the call application voice handoff-string command has been replaced by the param handoff-string command.
call application voice max-extension-length
Cisco IOS Release 12.3(14)T and later releases support Cisco CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) Tcl scripts version 2.1.0.0 and greater. In these releases, the call application voice max-extension-length command has been replaced by the param max-extension-length command.
call application voice max-time-call-retry
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice max-time-call-retry command is replaced by the param max-time-call-retry command. See the param max-time-call-retry command for more information.
To assign the maximum length of time for which calls to Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) can stay in a call queue, use the call application voice max-time-call-retry command in global configuration mode. To remove the maximum length of time, use the no form of this command.
call application voice application-name max-time-call-retry seconds
no call application voice application-name max-time-call-retry seconds
Syntax Description
Command Default
The default maximum length of time that calls can stay in a call queue is 600 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. The call application voice max-time-retry command allows you set a time limit for the redialing of pilot numbers under the following circumstances:
•
•
•
•
When the time period set by the call application voice max-call-retry command expires, one of the following two events will occur:
•
•
Examples
In the following example, the length of time for which calls can try to reach ephone hunt group 1 and ephone hunt group 2 is 90 seconds. If a caller selects the AA menu option for either hunt group and all of its ephone-dns configured in the list command are busy, the call will keep retrying the ephone hunt group's pilot number until one of the ephone-dns is available or 90 seconds has elapsed. When 90 seconds elapses, the call will go to voice mail.
Router(config)# ephone-hunt 1 peerRouter(config-ephone-hunt)# pilot 1111Router(config-ephone-hunt)# list 1001, 1002, 1003, 1004Router(config)# ephone-hunt 2peerRouter(config-ephone-hunt)# pilot 2222Router(config-ephone-hunt)# list 2001, 2002, 2003, 2004Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa max-call-retry-timer 90Related Commands
call application voice max-time-vm-retry
Cisco IOS Release 12.3(14)T and later releases support Cisco CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) Tcl scripts version 2.1.0.0 and greater. In these releases, the call application voice max-time-vm-retry command has been replaced by the param max-time-vm-retry command.
call application voice number-of-hunt-grps
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice number-of-hunt-grps command is replaced by the param number-of-hunt-grps command. See the param number-of-hunt-grps command for more information.
To declare the maximum number of ephone hunt-group menus supported by Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD), use the call application voice number-of-hunt-grps command in global configuration mode. To remove the maximum number of ephone hunt-group menus supported by Cisco CME B-ACD, use the no form of this command.
call application voice application-name number-of-hunt-grps number
no call application voice application-name number-of-hunt-grps number
Syntax Description
Command Default
Three ephone hunt-group menus are supported by Cisco CME B-ACD.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. The number argument declares the number of ephone hunt groups only. The menu option for direct extension access (see the call application voice dial-by-extension-option command) is not included.
Examples
The following example configures a Cisco CME B-ACD call queue script to use three ephone hunt groups and one direct extension access number, making the number argument in the call application voice number-of-hunt-grps equal to 3. The ephone-hunt command is used to configure the three ephone hunt groups. The call application voice dial-by-extension-option command is used to enable direct extension access and set the access number to 1.
Router(config)# ephone-hunt 1 peerRouter(config-ephone-hunt)# pilot 1111Router(config-ephone-hunt)# list 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010Router(config)# ephone-hunt 2 peerRouter(config-ephone-hunt)# pilot 2222Router(config-ephone-hunt)# list 2001, 2002, 2003, 2004, 2005, 2006Router(config-ephone-hunt)# final 9000Router(config)# ephone-hunt 3 peerRouter(config-ephone-hunt)# pilot 3333Router(config-ephone-hunt)# list 3001, 3002, 3003, 3004Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa dial-by-extension 1Router(config)# call application voice aa number-of-hunt-grps 3Related Commands
call application voice queue-len
Effective with Cisco IOS Release 12.3(14)T and later, the call application queue-len command is replaced by the param queue-len command. See the param queue-len command for more information.
To set the maximum number of calls allowed for each ephone hunt group's call queue that is used by Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD), use the call application voice queue-len command in global configuration mode. To remove the queue-length setting, use the no form of this command.
call application voice application-name queue-len number
no call application voice application-name queue-len number
Command Default
Defaults
Thirty calls are allowed in each call queue.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD call queue scripts. The following sequence of events might occur:
•
•
•
In that case, the call will be sent to a queue for that individual hunt group. The number of calls that each ephone hunt group can hold in its queue is configured by the call application voice queue-len command.
In the following configuration example, ephone hunt group 1 supports two ephone-dns; ephone hunt group 2 supports three ephone-dns; and the queue length is 10 for both ephone hunt groups:
ephone-hunt 1 peerpilot 1111list 1001, 1002ephone-hunt 2 peerpilot 2222list 2001, 2002, 2003call application voice queue flash:app-b-acd-x.x.x.x.tcl
call application voice callqueuescriptfilename queue-len 10If ephone hunt group 1's ephone-dns are busy, ten more calls can be made to ephone hunt group 1. During that time, the calls in the queue would periodically retry the pilot numbers (call application voice max-time-retry-timer command) and receive secondary greetings (call application voice second-greeting-time command). If none of the calls has hung up or connected to an ephone-dn, the eleventh caller would hear the en_bacd_disconnect.au message and a busy signal. The default message is, "We are unable to take your call at this time. Please try again at a later time. Thank you for calling." Includes a four-second pause after the message.
For ephone hunt group 2, three calls can be connected to ephone-dns 2001, 2002, and 2003, and ten calls can be waiting in ephone hunt group 2's queue. If the status remains unchanged, the fourteenth caller hears the disconnect message and a busy signal. But if one of the earlier calls disconnects (either by leaving the queue or by ending a call), the fourteen call enters the queue.
The maximum number of calls allowed in the queues of ephone hunt groups must be based on the number of ports or trunks available. For example, if you had 20 foreign exchange office (FXO) ports and two ephone hunt groups, you could configure a maximum of ten calls per ephone hunt-group queue with the call application voice queue-len 10 command. You could use the same configuration if you had a single T1 trunk, which supports 23 channels.
Examples
The following example configures a Cisco CME B-ACD call queue script to allow a maximum of 12 calls to wait in each ephone hunt group's calling queue for ephone-dns to become available:
Router(config)# call application voice queue flash:app-b-acd-x.x.x.x.tcl
Router(config)# call application voice queue queue-len 12Related Commands
call application voice queue-manager-debugs
Effective with Cisco IOS Release 12.3(14)T and later, the call application queue-manager-debugs command is replaced by the param queue-manager-debugs command. See the param aa-hunt command for more information.
To enable or disable the collection of call queue debug information from Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD), use the call application voice queue-manager-debugs command in global configuration mode. To remove the current setting, use the no form of this command with the keyword that was used in the previous occurrence of the call application voice queue-manager-debugs command.
call application voice application-name queue-manager-debugs [0 | 1]
no call application voice application-name queue-manager-debugs [0 | 1]
Syntax Description
application-name
Application name given to the call queue script in the call application voice command.
0
Disables debugging.
1
Enables debugging.
Command Default
The collection of call queue debug information from Cisco CME B-ACD is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD call queue scripts. It enables the collection of data regarding call queue activity. It is used in conjunction with the debug voip ivr script command. Both commands must be enabled at the same time.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example configures a Cisco CME B-ACD call queue script to enable debugging for the collection of data for the debug voip ivr script command:
Router(config)# call application voice queue flash:app-b-acd-x.x.x.x.tcl
Router(config)# call application voice queue queue-manager-debugs 1Related Commands
call application voice second-greeting-time
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice second-greeting-time command is replaced by the param second-greeting-time command. See the param second-greeting-time command for more information.
To set the delay before the second greeting is played after a caller joins a Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) calling queue and set the interval of time at which the second-greeting message is repeated, use the call application voice second-greeting-time command in global configuration mode. To remove the second-greeting time, use the no form of this command.
call application voice application-name second-greeting-time seconds
no call application voice application-name second-greeting-time seconds
Syntax Description
Command Default
The second-greeting delay time is 60 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. A second greeting is an audio message of up to 15 seconds in length. The default announcement is, "All agents are currently busy assisting other customers. Continue to hold for assistance. Someone will be with you shortly." The second-greeting message is only presented to callers waiting in a CME B-ACD call queue.
The second-greeting time is clocked when the second-greeting message begins, not after it ends. For example, if the second greeting were 15 seconds in length and the configured second-greeting time were 70 seconds, the greeting would begin every 70 seconds, not 85 seconds as if to allow for the 15-second message.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example configures a Cisco CME B-ACD AA script to allow a second-greeting message to be repeated every 50 seconds as long as a call is in a call queue.
Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice AAscriptfilename second-greeting-time 50Related Commands
call application voice voice-mail
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice voice-mail command is replaced by the param voice-mail command. See the param voice-mail command for more information.
To assign a pilot number for the Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) service's voice mail, use the call application voice voice-mail command in global configuration mode. To remove the voice-mail pilot number, use the no form of the command.
call application voice application-name voice-mail number
no call application voice application-name voice-mail number
Syntax Description
Command Default
No voice-mail pilot number is configured for Cisco CME B-ACD.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. Only one pilot number is allowed per Cisco CME B-ACD service. Calls to the service will be sent to this voice mail number.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example configures a Cisco CME B-ACD voice-mail pilot number as 5000.
Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa voice-mail 5000Related Commands
call application voice
Defines a name for a voice application and specifies the location of the Tcl or VoiceXML document to load for this application.
call application voice welcome-prompt
Effective with Cisco IOS Release 12.3(14)T and later, the call application voice welcome-prompt command is replaced by the param welcome-prompt command. See the param welcome-prompt command for more information.
To assign an audio file that is used by the Cisco CallManager Express (Cisco CME) basic automatic call distribution (B-ACD) auto-attendant (AA) script for the welcome greeting, use the call application welcome-prompt command in global configuration mode. To remove the audio file assignment, use the no form of this command.
call application voice application-name welcome-prompt _audio-filename
no call application voice application-name welcome-prompt _audio-filename
Syntax Description
Command Default
The welcome audio file downloaded with Cisco CME B-ACD is used for the welcome prompt.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used only with with a version of the Cisco CME B-ACD script that is earlier than 2.1.0.0 and is valid only for the configuration of Cisco CME B-ACD AA scripts. The welcome greeting is the initial AA response to a caller. The default audio file used is en_bacd_welcome.au, which is is downloaded with Cisco CME B-ACD and announces, "Thank you for calling," and includes a two-second pause after the message.
The filename must be preceded by an underscore (_) character. In addition, it must not contain a language-code prefix, such as "en" for English. For example, for en_bacd_welcome.au, you must configure welcome-prompt _bacd_welcome.au instead of welcome-prompt _en_bacd_welcome.au.
For any configuration changes to take effect, you must reload the Cisco CME B-ACD scripts.
Examples
The following example sets file name en_welcome.au as the welcome greeting for Cisco CME B-ACD:
Router(config)# call application voice aa flash:app-b-acd-aa-x.x.x.x.tcl
Router(config)# call application voice aa welcome-prompt _bacd_welcome_2.auRelated Commands
caller-id
To specify whether to pass the local caller ID or the original caller ID with calls from a Cisco CallManager Express extension (ephone-dn) that is using loopback, use the caller-id command in ephone-dn configuration mode. To return to the default, use the no form of this command.
caller-id {local | passthrough}
no caller-id {local | passthrough}
Syntax Description
Defaults
For transferred calls, caller ID is provided by the number and name fields from the outbound side of the loopback-dn. For forwarded calls, caller ID is provided by the original caller ID of the incoming call. Settings for the caller-id block command and translation rules on the outbound side are executed.
Command Modes
Ephone-dn configuration
Command History
12.2(15)ZJ3
3.0
This command was introduced.
12.3(4)T
3.0
This command was integrated into Cisco IOS Release 12.3(4)T.
Usage Guidelines
This command is valid only for ephone-dns that are being used for loopback.
Examples
The following example selects local caller ID for redirected calls:
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 5001Router(config-ephone-dn)# loopback-dn 15 forward 4Router(config-ephone-dn)# caller-id localRouter(config-ephone-dn)# no huntstopRelated Commands
caller-id block (voice register template)
Note
To enable caller-ID blocking for outbound calls from a specific SIP phone, use the caller-id block command in voice register template configuration mode. To disable caller-ID blocking, use the no form of this command.
caller-id block
no caller-id block
Syntax Description
This command has no arguments or keywords.
Command Default
Caller ID blocking is disabled.
Command Modes
Voice register template configuration
Command History
Usage Guidelines
This command sets caller-ID blocking for outbound calls originating from any SIP phone that uses the specified template. This command requests the far-end gateway device to block the display of the calling party information for calls received from the specified SIP phone. This command does not affect the calling party information displayed for inbound calls received by the SIP phone. To apply a template to a SIP phone, use the template command in voice register pool configuration mode.
Examples
The following example shows how to enable caller-ID blocking in template 1:
Router(config)# voice register template 1Router(config-register-temp)# caller-id blockRelated Commands
caller-id block code (telephony-service)
To set a code for a user to dial to block the display of caller ID on selected outgoing calls from Cisco IP phones, use the caller-id block code command in telephony-service configuration mode. To remove the code, use the no form of this command.
caller-id block code code-string
no caller-id block code
Syntax Description
Defaults
No caller-ID blocking code is defined.
Command Modes
Telephony-service configuration
Command History
12.2(15)ZJ
3.0
This command was introduced.
12.3(4)T
3.0
This command was integrated into Cisco IOS Release 12.3(4)T.
Usage Guidelines
Once the caller-ID blocking code has been defined using this command, phone users should enter the caller-ID blocking code before dialing any call on which they want their caller ID not to display.
Examples
The following example sets a caller-ID blocking code of *4321:
Router(config)# telephony-serviceRouter(config-telephony)# caller-id block code *4321Related Commands
call-feature-uri
To specify the uniform resource identifier (URI) for soft keys on SIP phones registered to a Cisco Unified CME router, use the call-feature-uri command in voice register global configuration mode. To remove a URI association, use the no form of this command.
call-feature-uri cfwdall service-uri
no call-feature-uri cfwdall
Syntax Description
Command Default
No URI is associated with the soft key.
Command Modes
Voice register global configuration
Command History
Usage Guidelines
This command updates the service URI for call forward all in the configuration file downloaded from the Cisco Unified CME router to the SIP phones during phone registration. The configuration is updated when Call Forward All is enabled from the phone using the CfwdAll soft key.
After you configure this command, restart the phone by using the reset or restart command.
This command is not supported on the Cisco Unified IP Phone 7905, 7912, 7940, or 7960.
Examples
The following example shows how to specify the URI for the call forward all soft key:
Router(config)# voice register globalRouter(config-register-global)# call-feature-uri cfwdall http://1.4.212.11/cfwdallRelated Commands
call-forward
To globally apply dialplan-pattern expansion to redirecting numbers for extension numbers associated with SCCP IP phones in Cisco Unified CME, use the call-forward system command in telephony-service configuration mode. To disable the call-forward system command, use the no form of this command.
call-forward system redirecting-expanded
no call-forward system redirecting-expanded
Syntax Description
system
Call forward system parameter.
redirecting-expanded
Expand redirecting extensions to an E.164 number.
Command Default
The redirecting number is not expanded.
Command Modes
Telephony-service configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
Use this command to apply dialplan-pattern expansion on a per-system basis to individual nonSIP redirecting numbers, including original called and last reroute numbers, in a Cisco Unified CME system.
When A calls B, and B forwards the call to C; B is the original called number and the last reroute number. If C then forwards or transfers the call to another number, C becomes the original called number and the last reroute number. The dial-plan pattern expansion is applied to both redirecting numbers. Once the number is expanded, it remains expanded during the entire call instance.
The dial-plan pattern to be matched must be configured using the dialplan-pattern command.
Examples
The following example shows how to create a dialplan-pattern for expanding calling numbers to an E.164 number and to also apply the expansion globally to redirecting numbers.
Router(config)# voice register globalRouter(config-register-global)# dialplan-pattern 1 5105550... extension-length 5Router(config-register-global)# call-forward system redirecting-expandedRelated Commands
call-forward (voice register)
To globally apply dialplan-pattern expansion to redirecting numbers for extension numbers associated with SIP IP phones in Cisco Unified CME, use the call-forward system command in voice register global configuration mode. To disable the call-forward system command, use the no form of this command.
call-forward system redirecting-expanded
no call-forward system redirecting-expanded
Syntax Description
system
Call forward system parameter.
redirecting-expanded
Redirecting extension is to be expanded to an E.164 number.
Command Default
The redirecting number is not expanded.
Command Modes
Voice register global configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
Use this command to apply dialplan-pattern expansion on a per-system basis to individual SIP redirecting numbers, including original called and last reroute numbers, in Cisco Unified CME.
When A calls B, and B forwards the call to C; B is the original called number and the last reroute number. If C then forwards or transfers the call to another number, C becomes the original called number and the last reroute number. The dial-plan pattern expansion is applied to both redirecting numbers. Once the number is expanded, it remains expanded during the entire call instance.
This command supports call forward using B2BUA only.
The dial-plan pattern to be matched must be configured using the dialplan-pattern command.
Examples
The following example shows how to create a dialplan-pattern for expanding calling numbers of SIP phones to an E.164 number and to also apply the expansion globally to SIP redirecting numbers.
Router(config)# voice register globalRouter(config-register-global)# dialplan-pattern 1 5105550... extension-length 5Router(config-register-global)# call-forward system redirecting-expandedRelated Commands
call-forward all
To configure call forwarding so that all incoming calls to a directory number are forwarded to another directory number, use the call-forward all command in ephone-dn or ephone-dn-template configuration mode. To disable call forwarding, use the no form of this command.
call-forward all directory-number
no call-forward all
Syntax Description
directory-number
Directory number to which calls are forwarded. Represents a fully qualified E.164 number.
Command Default
Call forwarding for all calls is not set.
Command Modes
Ephone-dn configuration
Ephone-dn-template configurationCommand History
Usage Guidelines
The call forwarding mechanism applies to the individual directory number and cannot be configured for individual Cisco Unified IP phones.
Note
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 shows how to set call forwarding of all calls on directory number 5001 to directory number 5005. All incoming calls destined for extension 5001 are forwarded to another Cisco IP phone with the extension number 5005:
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 5001Router(config-ephone-dn)# call-forward all 5005The following example uses an ephone-dn template to forward all calls for extension 5001 to extension 5005.
Router(config)# ephone-dn-template 3Router(config-ephone-dn-template)# call-forward all 5005Router(config-ephone-dn-template)# exitRouter(config)# ephone-dn 1Router(config-ephone-dn)# number 5001Router(config-ephone-dn)# ephone-dn-template 3Related Commands
call-forward b2bua all
To enable call forwarding for a Session Initiation Protocol (SIP) back-to-back user agent (B2BUA) so that all incoming calls are forwarded to another extension, use the call-forward b2bua all command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.
call-forward b2bua all directory-number
no call-forward b2bua all
Syntax Description
directory-number
Telephone number to which calls are forwarded. Represents a fully qualified E.164 number. Maximum length of the telephone number is 32.
Command Default
Disabled.
Command Modes
Voice register dn configuration (Cisco Unified SIP SRST only)
Voice register pool configurationCommand History
Usage Guidelines
This command in voice register dn configuration mode applies the call forward mechanism to a individual SIP extension in Cisco Unified CME or Cisco Unified SIP SRST. This command in voice register pool configuration mode is for Cisco Unified SIP SRST only and applies to SIP IP phones on which the extension appears.
If this command is configured in both the voice register dn and voice register pool configuration modes, the configuration under voice register dn takes precedence.
We recommend that you do not use this command to configure a SIP extension or SIP IP phone that is a member of a hunt group. If this command is configured for a member of a hunt group, remove the phone from any hunt group to which it is assigned to avoid forwarding calls to all phones in the hunt group.
The call-forward b2bua all command takes precedence over the call-forward b2bua busy and call-forward b2bua noan commands.
Note
Examples
Cisco Unified CME and Cisco Unified SIP SRST
The following example shows how to forward all incoming calls to extension 5001 on directory number 4, to extension 5005.
Router(config)# voice register dn 4Router(config-register-dn)# number 5001Router(config-register-dn)# call-forward b2bua all 5005Cisco Unified SIP SRST
The following example shows how to forward all incoming calls for extension 5001 on pool number 4, to extension 5005.
Router(config)# voice register pool 4Router(config-register-pool)# number 5001Router(config-register-pool)# call-forward b2bua all 5005Related Commands
call-forward b2bua busy
To enable call forwarding for a Session Initiation Protocol (SIP) back-to-back user agent (B2BUA) so that incoming calls to a busy extension are forwarded to another extension, use the call-forward b2bua busy command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.
call-forward b2bua busy directory-number
no call-forward b2bua busy
Syntax Description
directory-number
Telephone number to which calls are forwarded. Represents a fully qualified E.164 number. Maximum length of the telephone number is 32.
Command Default
Disabled.
Command Modes
Voice register dn configuration (Cisco Unified SIP SRST only)
Voice register pool configurationCommand History
Usage Guidelines
This command in voice register dn configuration mode applies the call forward mechanism to a individual SIP extension in Cisco Unified CME or Cisco Unified SIP SRST that is off-hook. This command in voice register pool configuration mode is for Cisco Unified SIP SRST only and applies to SIP IP phones on which the extension appears.
In Cisco Unified CME, call forward busy is also invoked when a call arrives for a destination that is configured but unregistered. A destination is considered to be configured if its number is listed under the voice register dn configuration.
If this command is configured in both voice register dn and voice register pool configuration modes, the configuration under voice register dn takes precedence.
We recommend that you do not use this command to configure a SIP extension or SIP IP phone that is a member of a hunt group. If this command is configured for a member of a hunt group, remove the phone from any hunt group to which it is assigned to avoid forwarding calls to all phones in the hunt group.
The call-forward b2bua all command takes precedence over the call-forward b2bua busy and call-forward b2bua noan commands.
Note
Examples
Cisco Unified CME and Cisco Unified SIP SRST
The following example shows how to forward all incoming calls to extension 5001 on directory number 4 to extension 5005 when extension 5001 is busy.
Router(config)# voice register dn 4Router(config-register-dn)# number 5001Router(config-register-dn)# call-forward b2bua busy 5005Cisco Unified SIP SRST
The following example shows how to forward calls from extension 5001 in pool 4 to extension 5005 when extension 5001 is busy.
Router(config)# voice register pool 4Router(config-register-pool)# number 5001Router(config-register-pool)# call-forward b2bua busy 5005Related Commands
call-forward b2bua mailbox
To control the specific voice-mail box selected in a voice-mail system at the end of a call forwarding exchange, use the call-forward b2bua mailbox command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.
call-forward b2bua mailbox directory-number
no call-forward b2bua mailbox
Syntax Description
Command Default
Disabled.
Command Modes
Voice register dn configuration (Cisco Unified SIP SRST only)
Voice register pool configurationCommand History
Usage Guidelines
This command is used to denote the voice-mail box to use at the end of a chain of call forwards to busy or no answer destinations. It can be used to forward calls to a voice-mail box that has a different number than the forwarding extension, such as a shared voice-mail box.
This command in voice register dn configuration mode applies the call forward mechanism to a individual SIP extension in Cisco Unified CME or Cisco Unified SIP SRST. This command in voice register pool configuration mode is for Cisco Unified SIP SRST only and applies to SIP IP phones on which the extension appears.
If this command is configured in both the voice register dn and voice register pool configuration modes, the configuration under voice register dn takes precedence.
We recommend that you do not use this command to configure a SIP extension or SIP IP phone that is a member of a hunt group. If this command is configured for a member of a hunt group, remove the phone from any hunt group to which it is assigned to avoid forwarding calls to all phones in the hunt group.
This command is used in conjunction with the call-forward b2bua all, call-forward b2bua busy, and call-forward b2bua noan commands.
Note
Examples
Cisco Unified CME and Cisco Unified SIP SRST
The following example shows how to forward all incoming calls to extension 5005 if an incoming call is forwarded to extension 5001, and extension 5001 is busy or does not answer.
Router(config)# voice register dn 4Router(config-register-dn)# number 5001Router(config-register-dn)# call-forward b2bua mailbox 5005Cisco Unified SIP SRST
The following example shows how to forward calls to extension 5005 if an incoming call is forwarded to extension 5001 on pool number 4, and extension 5001 is busy or does not answer.
Router(config)# voice register pool 4Router(config-register-pool)# number 5001Router(config-register-pool)# call-forward b2bua mailbox 5005Related Commands
call-forward b2bua noan
To enable call forwarding for a Session Initiation Protocol (SIP) back-to-back user agent (B2BUA) so that incoming calls to an extension that does not answer after a configured amount of time are forwarded to another extension, use the call-forward b2bua noan command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.
call-forward b2bua noan directory-number timeout seconds
no call-forward b2bua noan
Syntax Description
Command Default
Disabled.
Command Modes
Voice register dn configuration (Cisco Unified SIP SRST only)
Voice register pool configurationCommand History
Usage Guidelines
This command in voice register dn configuration mode applies the call forward mechanism to a individual SIP extension in Cisco Unified CME or Cisco Unified SIP SRST that remains unanswered after a specified length of time. This command in voice register pool configuration mode is for Cisco Unified SIP SRST only and applies to SIP IP phones on which the extension appears.
If this command is configured in both the voice register dn and voice register pool configuration modes, the configuration under voice register dn takes precedence.
We recommend that you do not use this command to configure a SIP extension or SIP IP phone that is a member of a hunt group. If this command is configured for a member of a hunt group, remove the phone from any hunt group to which it is assigned to avoid forwarding calls to all phones in the hunt group.
The call-forward b2bua all command takes precedence over the call-forward b2bua busy and call-forward b2bua noan commands.
Note
Examples
Cisco Unified CME and Cisco Unified SIP SRST
The following example shows how to forward calls to extension 5005 when extension 5001 is unanswered. The timeout before the call is forwarded to extension 5005 is 10 seconds.
Router(config)# voice register pool 4Router(config-register-pool)# number 5001Router(config-register-pool)# call-forward b2bua noan 5005 timeout 10Cisco Unified SIP SRST
The following example shows how to forward calls to extension 5005 when extension 5001 on pool number 4 is unanswered. The timeout before the call is forwarded to extension 5005 is 10 seconds.
Router(config)# voice register pool 4Router(config-register-pool)# number 5001Router(config-register-pool)# call-forward b2bua noan 5005 timeout 10Related Commands
call-forward b2bua unreachable
Note
To forward calls to a phone that is not registered to Cisco Unified CME, use the call-forward b2bua unreachable command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.
call-forward b2bua unreachable directory-number
no call-forward b2bua unreachable
Syntax Description
directory-number
Telephone number to which calls are forwarded. Represents a fully qualified E.164 number.
Defaults
Disabled
Command Modes
Voice register dn configuration
Voice register pool configurationCommand History
Usage Guidelines
Call forward unreachable is triggered when a call arrives for a destination that is configured but unregistered with Cisco CME. A destination is considered to be configured if its number is listed under the voice register pool or voice register dn configurations.
If call forward unreachable is not configured for a pool or directory number (DN) register, any calls that match the numbers in that pool or DN register will use call forward busy instead.
We recommend that you do not use this command with hunt groups. If the command is used, consider removing the phone from any assigned hunt groups, unless you want to forward calls to all phones in the hunt group.
Examples
The following example shows how to forward calls to extension 5005 when extension 5001 on directory number 4 is unreachable, either because it is unplugged or the network between the Cisco router and the extension is nonfunctional. The timeout before the call is forwarded to extension 5005 is 10 seconds.
Router(config)# voice register pool 4Router(config-register-dn)# number 5001Router(config-register-dn)# call-forward b2bua unreachable 5005 timeout 10Related Commands
call-forward busy
To configure call forwarding so that incoming calls to a busy extension (ephone-dn) are forwarded to another extension, use the call-forward busy command in ephone-dn or ephone-dn-template configuration mode. To disable call forwarding, use the no form of this command.
call-forward busy target-number [primary | secondary] [dialplan-pattern]
no call-forward busy
Syntax Description
Command Default
Call forwarding for a busy extension is not enabled.
Command Modes
Ephone-dn configuration
Ephone-dn-template configurationCommand History
Usage Guidelines
The call forwarding mechanism is applied to an individual extension (ephone-dn) and is not applied to the phone on which the extension appears.
Normally, call forwarding is applied to all dial peers that are created by the ephone-dn. An ephone-dn can create up to four dial peers:
•
•
•
•
The primary, secondary, and dialplan-pattern keywords allow you to apply call forwarding selectively to one or more dial peers based on the exact called number that was used to route the call to the ephone-dn. If none of the optional keywords is used, call forwarding applies to all dial-peers that are defined for the ephone-dn.
An ephone-dn can have all four types of call forwarding defined at the same time: all-calls, no-answer, busy, and night-service. Each type of call forwarding can have a different forwarding target defined in its target-number argument. If more than one type of call forwarding is in effect (is active) at one time, the precedence order for evaluating the different types is as follows:
1.
2.
3.
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 forwards all calls for the ephone-dn 2345 when it is busy.
Router(config)# ephone-dn 236Router(config-ephone-dn)# number 2345Router(config-ephone-dn)# call-forward busy 2000The following example uses an ephone-dn template to forward calls for extension 2345 when it is busy.
Router(config)# ephone-dn-template 6Router(config-ephone-dn-template)# call-forward busy 2000Router(config-ephone-dn-template)# exitRouter(config)# ephone-dn 236Router(config-ephone-dn)# number 2345Router(config-ephone-dn)# ephone-dn-template 6The following example creates a dial-plan pattern to expand extension numbers into E.164 numbers. It then sets call forwarding of incoming calls to directory number 5005. In this example, call forwarding on busy is applied only when callers dial the primary number for this ephone-dn, 5001.
Router(config)# telephony-serviceRouter(config-telephony)# dialplan-pattern 1 40855501.. extension-length 4 extension-pattern 50..Router(config-telephony)# exitRouter(config)# ephone-dn 1Router(config-ephone-dn)# number 5001 secondary 5002Router(config-ephone-dn)# call-forward busy 5005 primaryRelated Commands
call-forward max-length
To restrict the number of digits that can be entered using the CfwdALL soft key on an IP phone, use the call-forward max-length command in ephone-dn or ephone-dn-template configuration mode. To remove a restriction on the number of digits that can be entered, use the no form of this command.
call-forward max-length length
no call-forward max-length
Syntax Description
Command Default
There is no restriction on the number of digits that can be entered.
Command Modes
Ephone-dn configuration
Ephone-dn-template configurationCommand History
Usage Guidelines
This command can be used to prevent a phone user from using the CfwdALL soft key on an IP phone to forward calls to numbers that will incur toll charges when they receive forwarded calls.
If the length argument is set to 0, the CfwdALL soft key is completely disabled. If the ephone-dn associated with the first line button has an active call forward number when this command is used to set the length argument to 0, the CfwdALL soft key will be disabled after the next phone restart.
The restriction created by this command does not apply to destinations that are entered using the Cisco IOS command-line interface (CLI) or the Cisco Unified CME GUI.
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 restricts the number of digits that a phone user can enter using the CfwdALL soft key to four. In this example, extensions in the phone user's Cisco Unified CME system have four digits, so that means the user can use the IP phone to forward all calls to any extension in the system, but not to any number outside the system.
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 5001Router(config-ephone-dn)# call-forward max-length 4The following example uses an ephone-dn-template to restrict the number of digits that a phone user can enter using the CfwdALL soft key to four.
Router(config)# ephone-dn-template 4Router(config-ephone-dn-template)# call-forward max-length 4Router(config-ephone-dn-template)# exitRouter(config)# ephone-dn 1Router(config-ephone-dn)# number 5001Router(config-ephone-dn)# ephone-dn-template 4Related Commands
call-forward night-service
To automatically forward calls to another number during night-service hours, use the call-forward night-service command in ephone-dn or ephone-dn-template configuration mode. To disable automatic call forwarding during night service, use the no form of this command.
call-forward night-service target-number
no call-forward night-service
Syntax Description
Command Default
Calls are not forwarded during night-service hours.
Command Modes
Ephone-dn configuration
Ephone-dn-templateCommand History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
You must also configure the night-service bell command for this ephone-dn.
Night-service hours are defined using the night-service date and night-service day commands.
An ephone-dn can have all four types of call forwarding defined at the same time: all-calls, no-answer, busy, and night-service. Each type of call forwarding can have a different forwarding destination defined in its target-number argument. If more than one type of call forwarding is in effect (is active) at one time, the precedence order for evaluating the different types is as follows:
1.
2.
3.
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 establishes night-service hours from 1 p.m. Saturday until 8 a.m. Monday. During that time, calls to extension 1000 (ephone-dn 1) are forwarded to extension 2346. Note that the night-service bell command has also been used for ephone-dn 1.
telephony-servicenight-service day sat 13:00 12:00night-service day sun 12:00 08:00night-service code *1234!ephone-dn 1number 1000night-service bellcall-forward night-service 2346!ephone-dn 2number 2346ephone 12button 1:1ephone 13button 1:2The following example uses an ephone-dn template to apply call forwarding for extension 2876 during the night service hours established in the previous example.
ephone-dn-template 2call-forward night-service 2346ephone-dn 25number 2876ephone-dn-template 2Related Commands
call-forward noan
To configure call forwarding so that incoming calls to an extension (ephone-dn) that does not answer are forwarded to another number, use the call-forward noan command in ephone-dn or ephone-dn-template configuration mode. To disable call forwarding, use the no form of this command.
call-forward noan target-number timeout seconds [primary | secondary] [dialplan-pattern]
no call-forward noan
Syntax Description
Command Default
Call forwarding for an extension that does not answer is not enabled.
Command Modes
Ephone-dn configuration
Ephone-dn-template configurationCommand History
Usage Guidelines
The call forwarding mechanism is applied to an individual extension (ephone-dn) and is not applied to the phone on which the extension appears.
Normally, call forwarding is applied to all dial peers that are created by the ephone-dn. An ephone-dn can create up to four dial peers:
•
•
•
•
The primary, secondary, and dialplan-pattern keywords allow you to apply call forwarding selectively to one or more dial peers based on the exact called number that was used to route the call to the ephone-dn. If none of the optional keywords is used, call forwarding applies to all dial-peers that are defined for the ephone-dn.
An ephone-dn can have all four types of call forwarding defined at the same time: all-calls, no-answer, busy, and night-service. Each type of call forwarding can have a different forwarding target defined in its target-number argument. If more than one type of call forwarding is in effect (is active) at one time, the precedence order for evaluating the different types is as follows:
1.
2.
3.
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 forwards calls for the ephone-dn 2345 when it does not answer.
Router(config)# ephone-dn 236Router(config-ephone-dn)# number 2345Router(config-ephone-dn)# call-forward busy 2000The following example uses an ephone-dn-template to forward calls for the ephone-dn 2345 when it does not answer.
Router(config)# ephone-dn-template 8Router(config-ephone-dn-template)# call-forward busy 2000Router(config-ephone-dn-template)# exitRouter(config)# ephone-dn 236Router(config-ephone-dn)# number 2345Router(config-ephone-dn)# ephone-dn-template 8The following example creates a dial-plan pattern to expand extension numbers into E.164 numbers. It then sets call forwarding of incoming calls to directory number 5005. In this example, call forwarding on no answer is applied only when callers dial the primary number for this ephone-dn, 5001.
Router(config)# telephony-serviceRouter(config-telephony)# dialplan-pattern 1 40855501.. extension-length 4 extension-pattern 50..Router(config-telephony)# exitRouter(config)# ephone-dn 1Router(config-ephone-dn)# number 5001 secondary 5002Router(config-ephone-dn)# call-forward noan 5005 primaryRelated Commands
call-forward pattern
To specify a pattern for calling-party numbers that are able to support the ITU-T H.450.3 standard for call forwarding, use the call-forward pattern command in telephony-service configuration mode. To remove the pattern, use the no form of this command.
call-forward pattern pattern
no call-forward pattern pattern
Syntax Description
Command Default
No call-forward pattern is defined.
Command Modes
Telephony-service configuration
Command History
12.2(11)YT
2.1
This command was introduced.
12.2(15)T
2.1
This command was integrated into Cisco IOS Release 12.2(15)T.
Usage Guidelines
Use this command with Cisco IOS Telephony Services (ITS) V2.1, Cisco CallManager Express 3.0, or a later version.
When H.450.3 call forwarding is selected, the router must be configured with a Tool Command Language (Tcl) script that supports the H.450.3 protocol. The Tcl script is loaded on the router by using the call application voice command.
The pattern match in this command is against the phone number of the calling party. When an extension number has forwarded its calls and an incoming call is received for that number, the router sends an H.450.3 response back to the original calling party to request that the call be placed again using the forward-to destination.
Calling numbers that do not match the patterns defined using this command are forwarded using Cisco-proprietary call forwarding for backward compatibility.
Examples
The following example specifies that all 4-digit directory numbers that begin with 4 should use the H.450.3 standard whenever they are forwarded:
Router(config)# telephony-serviceRouter(config-telephony)# call-forward pattern 4...The following example forwards all calls that support the H.450.3 standard:
Router(config)# telephony-serviceRouter(config-telephony)# call-forward pattern .TRelated Commands
calling-number local
To replace a calling-party number and name with the forwarding-party number and name (the local number and name) in calls forwarded using local hairpin call routing, use the calling-number local command in telephony-service configuration mode. To reset to the default, use the no form of this command.
calling-number local [secondary]
no calling-number local
Syntax Description
secondary
(Optional) Uses the secondary number associated with the forwarding party instead of the primary number. The primary number is the default if this keyword is not used.
Defaults
Calling-party numbers and names are used in forwarded calls.
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
In Cisco CME 3.2 and earlier versions, this command is used with the Tool Command Language (Tcl) script app-h450-transfer.2.0.0.7 or a later version.
In Cisco CME 3.3 and later versions, this command can be used without the TCL script because the functionality is integrated into the default IOS voice application framework.
If the ephone-dn used by a forwarding party has a secondary number in addition to its primary number and neither number is registered with the gatekeeper, the primary number is the number that appears as the calling number on hairpin-forwarded calls when the calling-number local command is used. If only one of the numbers is registered with the gatekeeper, the registered number is the number that appears as the calling number. If both numbers are registered with the gatekeeper, the primary number is the number that appears as the calling number.
If the ephone-dn used by a forwarding party has a secondary number in addition to its primary number and the calling-number local secondary command is used, the secondary number is the number that appears as the calling number on hairpin-forwarded calls if both numbers are registered with the gatekeeper or if both numbers are not registered. If only one number is configured to register with the gatekeeper, the number that is registered appears as the calling number.
Examples
The following example specifies use of the name and number of the local forwarding party in hairpin-forwarded calls:
Router(config)# telephony-serviceRouter(config-telephony)# calling-number localThe following examples demonstrate the use of the calling-number local command without the secondary keyword.
•
calling-number localephone-dn 1number 1234 secondary 4321 no-reg•
calling-number localephone-dn 1number 1234 secondary 4321 no-reg primary•
calling-number localephone-dn 1number 1234 secondary 4321 no-reg bothor
number 1234 secondary 4321The following examples demonstrate the use of the calling-number local secondary command.
•
calling-number local secondaryephone-dn 1number 1234 secondary 4321 no-reg•
calling-number local secondaryephone-dn 1number 1234 secondary 4321 no-reg primary•
calling-number local secondaryephone-dn 1number 1234 secondary 4321 no-reg bothor
number 1234 secondary 4321callmonitor
To enable call monitoring messaging functionality on a SIP endpoint in a VoIP network, use the callmonitor command in voice-service configuration mode. To return to the default, use the no form of this command.
callmonitor
no callmonitor
Syntax Description
This command has no arguments or keywords.
Command Default
Monitoring service is disabled.
Command Modes
Voice-service configuration (config-voi-serv)
Command History
Usage Guidelines
Use this command in voice service configuration mode to allow a SIP endpoint, such as an external feature server, to watch call activity on a VoIP network.
To view call activity, use the show callmon command.
Examples
The following partial output shows the configuration for the callmonitor command:
router# show running-configuration!!!voice service voipgcidcallmonitorallow-connections h323 to h323allow-connections h323 to sipallow-connections sip to h323allow-connections sip to sipno supplementary-service sip moved-temporarilysipregistrar server expires max 120 min 60!!Related Commands
call-park system
To specify system parameters for the call-park feature, use the call-park system redirect command in telephony-service configuration mode. To return to the default, use the no form of this command.
call-park system {redirect}
no call-park system
Syntax Description
redirect
H.323 and SIP calls will use H.450 or the SIP Refer method of call forwarding or transfer to park calls and to pick up calls from park
Command Default
H.323 and SIP calls use hairpin call forwarding or transfer to park calls and to pick up calls from park.
Command Modes
Telephony-service configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Examples
The following example specifies that H.323 and SIP calls should use the H.450 or SIP Refer method of call forwarding or transfer to park calls and pick up calls from park:
Router(config)# telephony-serviceRouter(config-telephony)# call-park system redirectcall-waiting (voice register pool)
To enable call-waiting option on a SIP phone, use the call-waiting command in voice register pool configuration mode. To disable call waiting, use the no form of this command.
call-waiting
no call-waiting
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Voice register pool configuration mode
Command History
Usage Guidelines
The call waiting feature is enabled by default on SIP phones. To disable call waiting, use the no call-waiting command.
Examples
The following example shows how to disable call waiting on SIP phone 1:
Router(config)# voice register pool 1Router(config-register-pool)# no call-waitingRelated Commands
voice register pool
Enters voice register pool configuration mode for SIP phones.
call-waiting beep
To allow call-waiting beeps to be accepted by or generated from an ephone-dn, use the call-waiting beep command in ephone-dn or ephone-dn-template configuration mode. To disable the acceptance and generation of call-waiting beeps by an ephone-dn, use the no form of this command.
call-waiting beep [accept | generate]
no call-waiting beep [accept | generate]
Syntax Description
accept
(Optional) Allows call-waiting beeps to be accepted by an ephone-dn.
generate
(Optional) Allows call-waiting beeps to be generated by an ephone-dn.
Command Default
Call-waiting beeps are accepted and generated.
Command Modes
Ephone-dn configuration
Ephone-dn-template configurationCommand History
Usage Guidelines
The call-waiting beep command must be used with the ephone-dn command. The call-waiting beep command is used like a toggle and can be switched on and off for each ephone-dn.
A beep can be heard only if both sending and receiving ephone-dns are configured to accept call-waiting beeps.
To display how call-waiting beeps are configured, use the show running-config command in the privileged EXEC configuration mode. If the no call-waiting beep generate and no call-waiting beep accept commands are configured, the show running-config output will display the no call-waiting beep command.
If you configure a button to have a silent ring using the s option of the button command, you will not hear a call-waiting beep regardless of whether the ephone-dn associated with the button is configured to generate a call-waiting beep.
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 configures ephone-dn 1 and ephone-dn 2 not to accept and not to generate call-waiting beeps:
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 2588Router(config-ephone-dn)# no call-waiting beep acceptRouter(config-ephone-dn)# no call-waiting beep generateRouter(config-ephone-dn)# exitRouter(config)# ephone-dn 2Router(config-ephone-dn)# number 2589Router(config-ephone-dn)# no call-waiting beep acceptRouter(config-ephone-dn)# no call-waiting beep generateRouter(config-ephone-dn)# exitThe following example uses an ephone-dn template to set the same attributes as in the previous example:
Router(config)# ephone-dn-template 5Router(config-ephone-dn-template)# no call-waiting beep acceptRouter(config-ephone-dn-template)# no call-waiting beep generateRouter(config-ephone-dn-template)# exitRouter(config)# ephone-dn 1Router(config-ephone-dn)# number 2588Router(config-ephone-dn)# ephone-dn-template 5Router(config-ephone-dn)# exitRouter(config)# ephone-dn 2Router(config-ephone-dn)# number 2589Router(config-ephone-dn)# ephone-dn-template 5Router(config-ephone-dn)# exitThe following example configures ephone-dn 1 and ephone-dn 2 to switch back to accept call-waiting beeps. Ephone-dn 1 and ephone-dn 2 now accept but do not generate call-waiting beeps.
Router(config)# ephone-dn 1Router(config-ephone-dn)# call-waiting beep acceptRouter(config)# ephone-dn 2Router(config-ephone-dn)# call-waiting beep acceptRelated Commands
show running-config
Displays the contents of the currently running configuration file or the configuration for a specific interface, or map class information.
call-waiting ring
To allow an ephone-dn to use a ring sound for call-waiting notification, use the call-waiting ring command in ephone-dn or ephone-dn-template configuration mode. To disable the ring notification, use the no form of this command.
call-waiting ring
no call-waiting ring
Syntax Description
This command has no arguments or keywords.
Command Default
The ephone-dn accepts call waiting and uses beeps for notification.
Command Modes
Ephone-dn configuration
Ephone-dn-template configurationCommand History
Usage Guidelines
To use a ring sound for call-waiting notification on an ephone-dn, you must ensure that the ephone-dn will accept secondary calls while it is connected to another line. The acceptance of call waiting is the default ephone-dn behavior. However, the no call-waiting beep accept command can change this default so an ephone-dn does not accept call waiting. This command must be removed for ringing notification to work.
The call-waiting ring command will automatically disable a call-waiting beep configuration.
If you configure a button to have a silent ring using the s option of the button command, you will not hear a call-waiting ring regardless of whether the ephone-dn associated with the button is configured to generate a call-waiting ring.
Note
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 configures ephone-dn 1 and ephone-dn 2 to use ringing for their call-waiting notification:
Router(config)# ephone-dn 1Router(config-ephone-dn)# call-waiting ringRouter(config)# ephone-dn 2Router(config-ephone-dn)# no call-waiting ringThe following example uses an ephone-dn template to set the same attributes as in the previous example:
Router(config)# ephone-dn-template 9Router(config-ephone-dn-template)# call-waiting ringRouter(config-ephone-dn-template)# exitRouter(config)# ephone-dn-template 10Router(config-ephone-dn-template)# no call-waiting ringRouter(config-ephone-dn-template)# exitRouter(config)# ephone-dn 1Router(config-ephone-dn)# ephone-dn-template 9Router(config-ephone-dn)# exitRouter(config)# ephone-dn 2Router(config-ephone-dn)# ephone-dn-template 10Router(config-ephone-dn)# exitRelated Commands
call-waiting beep
Allows call-waiting beeps to be accepted by or generated from an ephone-dn.
capf-auth-str
To define a string of digits that a user enters at the phone for CAPF authentication, use the capf-auth-str command in ephone configuration mode. To return to the default, use the no form of this command.
capf-auth-str digit-string
no capf-auth-str
Syntax Description
Command Default
No authentication string exists for the phone.
Command Modes
Ephone configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
This command is used with Cisco Unified CME phone authentication to create or remove an authentication string (Personal Identification Number or PIN) for the specified secure ephone. Use this command if the auth-string keyword is specified in the auth-mode command. Once you specify a CAPF authentication string, it becomes part of the ephone configuration. This value can also be set globally or per ephone using the auth-string command in CAPF configuration mode.
Use the show capf-server auth-str command to display configured authentication strings.
When a phone is configured for a certificate upgrade that requires auth-string authentication, the CAPF initiation needs to be performed manually by the phone user using the following steps:
1.
2.
3.
4.
5.
Examples
The following example specifies the type of authentication for ephone 392 is an authentication string that is entered from the phone, and then defines the string as 38593.
ephone 392button 1:23 2:24 3:25device-security-mode authenticatedcert-oper upgrade auth-mode auth-stringcapf-auto-str 38593S
Related Commands
capf-server
To enter CAPF-server configuration mode to set CAPF server parameters, use the capf-server command in global configuration mode. To remove the CAPF server configuration, use the no form of this command.
capf-server
no capf-server
Syntax Description
This command has no keywords or arguments.
Command Default
No CAPF server configuration is present.
Command Modes
Global configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
This command is used with Cisco Unified CME phone authentication.
Examples
The following example sets parameters for the CAPF server:
Router(config)# capf-serverRouter(config-capf-server)# source address 10.10.10.1
Router(config-capf-server)# trustpoint-label server25
Router(config-capf-server)# cert-oper upgrade all
Router(config-capf-server)# cert-enroll-trustpoint server12 password 0 x8oWiet
Router(config-capf-server)# auth-mode auth-string
Router(config-capf-server)# auth-string generate all
Router(config-capf-server)# port 3000
Router(config-capf-server)# keygen-retry 5
Router(config-capf-server)# keygen-timeout 45
Router(config-capf-server)# phone-key-size 2048
cert-enroll-trustpoint
To enroll the CAPF with the CA or RA, use the cert-enroll-trustpoint command in CAPF-server configuration mode. To remove an enrollment, use the no form of this command.
cert-enroll-trustpoint ca-label password {0 | 1} password-string
no cert-enroll-trustpoint
Syntax Description
Command Default
The CAPF server is not enrolled with the CA or RA.
Command Modes
CAPF-server configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
This command is used with Cisco Unified CME phone authentication.
Examples
The following example specifies that the CAPF server should enroll with the trustpoint named server12 (the CA) using the password x8oWiet, which should be encrypted:
Router(config)# capf-serverRouter(config-capf-server)# source address 10.10.10.1
Router(config-capf-server)# trustpoint-label server25
Router(config-capf-server)# cert-oper upgrade all
Router(config-capf-server)# cert-enroll-trustpoint server12 password 0 x8oWiet
Router(config-capf-server)# auth-mode auth-string
Router(config-capf-server)# auth-string generate all
Router(config-capf-server)# port 3000
Router(config-capf-server)# keygen-retry 5
Router(config-capf-server)# keygen-timeout 45
Router(config-capf-server)# phone-key-size 2048
cert-oper (CAPF-server)
To initiate the specified certificate operations for all ephones, use the cert-oper command in CAPF-server configuration mode. To return to the default, use the no form of this command.
cert-oper {delete all | fetch all | upgrade all}
no cert-oper
Syntax Description
delete all
Remove all phone certificates.
fetch all
Retrieve all phone certificates for troubleshooting.
upgrade
Install or upgrade all phone certificates.
Command Default
A certificate operation is not specified.
Command Modes
CAPF-server configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
This command is used with Cisco Unified CME phone authentication. The cert-oper command in ephone configuration mode can also be used to specify certificate operations for individual ephones. Note that the keywords for that command are different than for this command.
Examples
The following example instructs the CAPF server to upgrade all phone certificates.
Router(config)# capf-serverRouter(config-capf-server)# source address 10.10.10.1
Router(config-capf-server)# trustpoint-label server25
Router(config-capf-server)# cert-oper upgrade all
Router(config-capf-server)# cert-enroll-trustpoint server12 password 0 x8oWiet
Router(config-capf-server)# auth-mode auth-string
Router(config-capf-server)# auth-string generate all
Router(config-capf-server)# port 3000
Router(config-capf-server)# keygen-retry 5
Router(config-capf-server)# keygen-timeout 45
Router(config-capf-server)# phone-key-size 2048
Related Commands
cert-oper (ephone)
To initiate a certificate activity for an individual ephone and specify the type of authentication, use the cert-oper command in ephone configuration mode. To return to the default, use the no form of this command.
cert-oper {delete | fetch | upgrade} {auth-string | LSC | MIC | null-string}
no cert-oper
Syntax Description
Command Default
No certificate activity is specified.
Command Modes
Ephone configuration
Command History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
This command is used with Cisco Unified CME phone authentication.
Phones require digitally signed certificates to participate in secure communications. In most cases, IP phones are shipped with MICs. At times, it may become necessary to replace an expired or revoked MIC. The CAPF server acts as a proxy for fetching a new certificate for the IP phone. The certificate thus issued through CAPF is an LSC.
When a phone is configured for certificate upgrade with auth-string authentication, the password string is entered into the ephone configuration using the capf-auth-str command. CAPF initiation is then manually performed at the phone using the following steps:
1.
2.
3.
4.
5.
To initiate certificate operations for all phones, use the cert-oper command in CAPF-server configuration mode. Note that the keywords for that command are different than for this command.
Examples
The following example specifies the type of authentication for ephone 392 is an authentication string that is entered from the phone, and then defines the string as 38593.
ephone 392button 1:23 2:24 3:25device-security-mode authenticatedcert-oper upgrade auth-mode auth-stringcapf-auto-str 38593Related Commands
capf-auth-str
Defines a string of digits that a user enters at the phone for CAPF authentication
cert-oper (CAPF server)
Initiates certificate operations for all ephones.
clear telephony-service ephone-attempted-registrations
To empty the log of ephones that unsuccessfully attempt to register with Cisco Unified CME, use the clear telephony-service ephone-attempted-registrations command in privileged EXEC configuration mode.
clear telephony-service ephone-attempted-registrations
Syntax Description
This command has no keywords or arguments.
Command Default
The log continues to accumulate attempted ephone registrations.
Command Modes
Privileged EXEC
Command History
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 auto-reg-ephone command blocks the automatic registration of ephones whose MAC addresses are not explicitly listed in the configuration. When automatic registration is blocked, Cisco Unified CME records the MAC addresses of phones that attempt to register but cannot because they are blocked.
Use the show ephone attempted-registrations command to view the list of phones that have attempted to register but have been blocked. The clear telephony-service ephone-attempted-registrations command clears the list.
Examples
The following example clears the attempted-registrations log.
Router# clear telephony-service ephone-attempted-registrationsRelated Commands
clear telephony-service conference hardware number
To drop all conference parties and clear the conference call, use the clear telephony-service conference hardware number command in privileged EXEC mode.
clear telephony-service conference hardware number number
Syntax Description
Command Default
The conference call continues with all current parties.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the show telephony-service conference hardware command to display the active hardware conferences. Use the clear telephony-service conference hardware number command to clear the desired conference.
Examples
The following example clears the conference number 1111 and drops all its parties:
Router# clear telephony-service conference hardware number 1111Related Commands
show telephony-service conference hardware
Displays information about hardware conferences in a Cisco CME system.
clear telephony-service xml-event-log
To clear the event table used for the Cisco Unified CME XML application, use the clear telephony-service xml-event-log command in privileged EXEC mode.
clear telephony-service xml-event-log
Syntax Description
This command has no keywords or arguments.
Command Default
The XML event table is not cleared.
Command Modes
Privileged EXEC
Command History
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 show fb-its-log command displays the contents of the XML event table.
Examples
The following example clears the entries from the XML event table:
Router# clear telephony-service xml-event-logRelated Commands
cnf-file
To specify the generation of different phone configuration files by type of phone or by individual phone, use the cnf-file command in telephony-service configuration mode. To return to the default, use the no form of this command.
cnf-file {perphonetype | perphone}
no cnf-file {perphonetype | perphone}
Syntax Description
perphonetype
A separate configuration file is generated for each type of phone.
perphone
A separate configuration file is generated for each phone.
Command Default
A single configuration file is used for all phones.
Command Modes
Telephony-service
Command History
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
Configuration files can be applied in the following ways:
•
•
•
To reset the type of configuration file to the default, use the no form of this command and the keyword that you previously used to set the type.
This feature is supported only on the following phones:
•
•
•
•
Examples
The following example selects flash memory as the configuration file storage location and per-phone as the type of configuration files that the system should generate.
telephony-servicecnf-file location flash:cnf-file perphoneRelated Commands
cnf-file location
To specify a storage location for phone configuration files, use the cnf-file location command in telephony-service configuration mode. To return to the default, use the no form of this command.
cnf-file location {flash: | slot0: | tftp tftp-url}
no cnf-file location {flash: | slot0: | tftp tftp-url}
Syntax Description
flash:
Router flash memory.
slot0:
Router slot 0 memory.
tftp tftp-url
External TFTP server at the specified URL.
Command Default
A single phone configuration file is stored in system memory and is used by all phones.
Command Modes
Telephony-service configuration
Command History
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
You can specify any of the following four locations to store configuration files:
•
•
Note
•
TFTP does not support file deletion. When configuration files are updated, they overwrite any existing configuration files with the same name. If you change the configuration file location, files are not deleted from the TFTP server.
To reset the location to the default, use the no form of this command and the keyword that you previously used to set the location.
This feature is supported only on the following phones:
•
•
•
•
Examples
The following example selects flash memory as the configuration file storage location and per-phone as the type of configuration files that the system should generate.
telephony-servicecnf-file location flash:cnf-file perphoneRelated Commands
cnf-file
Specifies the use of different phone configuration files by type of phone or by individual phone.
codec (ephone)
To select a preferred codec for Cisco Unified CME to use when setting up calls for a phone, use the codec command in ephone or ephone-template configuration mode. To return to the default, use the no form of this command.
codec {g711ulaw | g729r8 [dspfarm-assist]}
no codec
Syntax Description
Command Default
G.711 mu-law
Command Modes
Ephone configuration
Ephone-template configurationCommand History
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 can be used to help save network bandwidth for a remote IP phone.
When you use the codec command without the dspfarm-assist keyword, you only affect calls between two phones on the Cisco Unified CME router (such as between an IP phone and another IP phone or between an IP phone and an FXS analog phone). The command has no effect on a call directed through a VoIP dial peer unless you use the dspfarm-assist keyword.
For calls to other phones in the same Cisco Unified CME system, an IP phone that is configured to use G.729 will always have its calls set up to use G.729. If the phone participates in a call on a line that is shared with a phone that is configured for G.729 or is paged together with another phone that is configured for G.729, it must use G.729.
For calls to phones that are not in the same Cisco Unified CME system (such as VoIP calls), the codec is negotiated based on the protocol that is used for the call (such as H.323). The Cisco Unified CME system plays no part in the negotiation.
When you use the g729r8 keyword to select the G.729r8 codec for the RTP segment between the IP phone and the Cisco Unified CME router and you also use the dspfarm-assist keyword, the router attempts to use DSP-farm resources in the following way. If the IP phone is in a VoIP call (H.323 or SIP) or a Cisco Unified CME conference in which the codec must be set to G.711, the router uses configured DSP-farm resources to attempt to return the segment between the phone and the Cisco Unified CME router to G.729. Note that adequate DSP resources must be appropriately configured separately.
You should consider your options carefully when deciding to use the dspfarm-assist keyword with the codec command. The benefit is that it allows calls to use the G.729r8 codec on the call leg between the IP phone and the Cisco Unified CME router, which saves network bandwidth. The disadvantage is that for situations requiring G.711 codecs, such as conferencing and Cisco Unity Express, DSP resources that are possibly scarce will be used to transcode the call, and delay will be introduced while voice is shuttled to and from the DSP. In addition, the overuse of this feature can mask configuration errors in the codec selection mechanisms involving dial peers and codec lists.
Therefore, it is recommended that the dspfarm-assist keyword be used sparingly and only when absolutely required for bandwidth savings or when you know the phone will be participating very little, if at all, in calls that require a G.711 codec.
If the dspfarm-assist keyword has been configured for a phone and a DSP resource is not available when needed for transcoding, a phone registered to the local Cisco Unified CME router will use G.711 instead of G.729r8. This is not true for non-SCCP call legs; if no DSP resource is available for the transcoding required for a conference, for example, the conference will not be created.
Note
This command can be part of an ephone template that is applied to several ephones. 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 selects the G.729 codec with DSP farm assist for calls that are being set up for ephone 25:
ephone 25button 1:37codec g729r8 dspfarm-assistThe following example uses ephone template 1 to apply the G.729 codec preference to ephone 25:
ephone-template 1codec g729r8ephone 25button 1:37ephone-template 1codec (voice register pool)
To specify the codec to be used when setting up a call for a SIP phone or group of SIP phones in Cisco Unified CME or Cisco Unified SIP SRST, use the codec command in voice register pool configuration mode. To disable a specified codec, use the no form of this command.
codec codec-type [bytes]
no codec
Syntax Description
Command Default
g729r8
Command Modes
Voice register pool configuration
Command History
12.4(4)T
Cisco CME 3.4
Cisco SIP SRST 3.4This command was introduced.
Usage Guidelines
When you use the codec command, you affect calls between two phones on the same Cisco Unified CME or Cisco Unified SRST router (such as between an IP phone and another IP phone or between an IP phone and an FXS analog phone).
Use this command to change the automatically selected default codec for the dial peer dynamically created when the SIP phone registers.
If codec values for the dial peers of a connection do not match, the call fails. The default codec for the POTS dial peer for a SCCP phone is G.711 and the default codec for a VoIP dial peer for a SIP phone is G.729. If neither the SCCP phone nor the SIP phone has been specifically configured to change the codec, calls between the two IP phones on the same router will produce a busy signal caused by the mismatched default codecs. For calls to other phones on the same Cisco router, a SIP phone that is configured to use G.711 will always have its calls set up to use G.711. If the phone participates in a call on a line that is shared with a phone that is configured for G.711, it must use G.711.
For calls to external phones; that is, phones that are not in the same Cisco Unified CME (such as VoIP calls), the codec is negotiated based on the protocol that is used for the call (such as H.323). Cisco Unified CME plays no part in the negotiation.
This command sets the codec configuration for an individual phone and overrides any previously configured codec selection set with the voice-class codec command.
Note
Examples
The following example shows how to set codec complexity to g711 for a SIP phone in pool 1:
Router(config)# voice register pool 1Router(config-register-pool)# codec g711ulaw...The following partial sample from the show voice register pool command shows the configuration for voice register pool 1:
pool tag 1Config MAC address is 0012.DABF.26BE Type is 7960 Number list 1: dn 1Proxy Ip address is 0.0.0.0 Codec is g711ulaw ... Dialpeers createddial-peer voice 4003 voipdestination-pattern 6667session target ipvsession protocol sip2vcodec g711ulawRelated Commands
conference (ephone-dn)
To configure a conference associated with a directory number, use the conference command in ephone-dn configuration mode. To disable a conference associated with a directory number, use the no form of this command.
conference {ad-hoc | meetme}
no conference {ad-hoc | meetme}
Syntax Description
Command Default
No conference is associated with the directory number.
Command Modes
Ephone-dn configuration
Command History
Usage Guidelines
Ad hoc conferences are those which begin as a call between the conference creator and another party. The creator then calls other parties and adds them to the original call creating a conference.
Meet-me conferences have a designated meet-me telephone or extension number that all parties call to join the conference. The conference creator initiates the meet-me conference by pressing the MeetMe soft key, then dialing the meet-me number. Other parties join the conference by dialing the meet-me number.
Use the ephone-dn command to configure enough extensions for your conference needs. Each extension can handle two conference parties if the dual-line keyword is used with he ephone-dn command as shown in the example below. Use the show ephone-dn command to display phone information for the extension.
Examples
The following example configures extension 9001 as a four-party meet-me conference number.
Router(config)# ephone-dn 1 dual-lineRouter(config-ephone-dn)# number 9001Router(config-ephone-dn)# conference meetmeRouter(config)# ephone-dn 2 dual-lineRouter(config-ephone-dn)# number 9001Router(config-ephone-dn)# conference meetmeYou must configure additional directory numbers to add more parties to the conference.
Related Commands
conference (voice register template)
To enable the soft key for conference in a SIP phone template, use the conference command in voice register template configuration mode. To disable the soft key, use the no form of this command.
conference
no conference
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Voice register template configuration
Command History
Usage Guidelines
This command enables a soft key for conference in the specified template which can then be applied to SIP phones. The conference soft key is enabled by default. To disable the conference soft key, use the no conference command. To apply a template to a SIP phone, use the template command in voice register pool configuration mode.
Examples
The following example shows how to disable the conference soft key in template 1:
Router(config)# voice register template 1Router(config-register-temp)# no conferenceRelated Commands
conference add-mode
To configure the mode for adding parties to ad hoc hardware conferences, use the conference add-mode command in ephone or ephone-template configuration mode. To return to the default, use the no form of this command.
conference add-mode [creator]
no conference add-mode [creator]
Syntax Description
Command Default
Any party can add other parties provided the creator remains in the conference.
Command Modes
Ephone configuration
Ephone-template configurationCommand History
Usage Guidelines
For more control of conference participation, use this command to specify that only the creator can add new parties. This configuration ensures that no one can add parties to the conference without the creator's knowledge.
Use this command to configure an ephone directly in ephone configuration mode, or use it to configure an ephone template in ephone-template configuration mode. Use the ephone-template command in ephone configuration mode to apply the ephone template to one or more ephones. Use the show telephony-service ephone command to display the add and drop modes for the ephone. Use the show telephony-service ephone-template command to display the ephone template.
Examples
The following example configures ad hoc hardware conferences so that only the creator can add participants.
Router(config)# ephone 1Router(config-ephone)# conference add-mode creatorRelated Commands
conference admin
To configure the ephone as the ad hoc and meet-me hardware conference administrator, use the conference admin command in ephone or ephone-template configuration mode. To return to the defaults, use the no form of this command.
conference admin
no conference admin
Syntax Description
This command has no arguments or keywords.
Command Default
This ephone is not the ad hoc and meet-me hardware conference administrator.
Command Modes
Ephone configuration
Ephone-template configurationCommand History
Usage Guidelines
Use this command to configure an ad hoc and meet-me hardware conference administrator. The administrator can:
•
•
•
The administrator can control the use of conference bridges by enforcing time limits and making sure conference bridges are available for scheduled meetings.
Use this command to configure an ephone directly in ephone configuration mode, or use it to configure an ephone template in ephone-template configuration mode. Use the ephone-template command in ephone configuration mode to apply the ephone template to one or more ephones. Use the show telephony-service ephone command to display the add and drop modes for the ephone. Use the show telephony-service ephone-template command to display the ephone template.
Examples
The following example configures ephone 1 as the ad hoc and meet-me hardware conference administrator.
Router(config)# ephone 1Router(config-ephone)# conference adminRelated Commands
conference drop-mode
To configure the mode for terminating ad hoc hardware conferences when parties drop out, use the conference drop-mode command in ephone or ephone-template configuration mode. To return to the default, use the no form of this command.
conference drop-mode [creator | local]
no conference drop-mode [creator | local]
Syntax Description
Command Default
The conference is not dropped, regardless of whether the creator hangs up, provided three parties remain in the conference.
Command Modes
Ephone configuration
Ephone-template configurationCommand History
Usage Guidelines
For more control of conference participation, use this command to specify that the conference drops when the creator hangs up (see the example). This configuration ensures that the conference cannot continue without the creator's presence.
Use this command to configure an ephone directly in ephone configuration mode, or use it to configure an ephone template in ephone-template configuration mode. Use the ephone-template command in ephone configuration mode to apply the ephone template to one or more ephones. Use the show telephony-service ephone command to display the add and drop modes for the ephone. Use the show telephony-service ephone-template command to display the ephone template.
Examples
The following example configures ad hoc hardware conferences so that only the creator can add participants and the active conference terminates when the creator hangs up.
Router(config)# ephone 1Router(config-ephone)# conference drop-mode creatorRelated Commands
conference hardware
To configure a Cisco Unified CallManager Express system for hardware conferencing only, use the conference hardware command in telephony-service configuration mode. To return to the default, three-party software conferencing, use the no form of this command.
conference hardware
no conference hardware
Syntax Description
This command has no arguments or keywords.
Command Default
Three-party ad hoc software conferencing.
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
Software conferencing allows a maximum of three parties in a conference. Use this command to take advantage of DSP farm resources for hardware conferencing which allows ad hoc conferences with more than three parties.
If you need ad hoc hardware conferences, you must use this command to configure DSP farm hardware conferencing. You can configure other conferencing features using the conference-join custom-cptone, conference-leave custom-cptone, and maximum conference-party commands in DSP farm profile configuration mode. Use the show dspfarm profile command to display the DSP farm profile.
Examples
The following example configures hardware conferencing as the default for ad hoc conferences on this Cisco Unified CallManager Express system:
Router(config)# telephony-serviceRouter(config-telephony)# conference hardwareRelated Commands
cor (ephone-dn)
This command is now documented as the corlist command. For complete command information, see the corlist command page.
cor (voice register pool)
To configure a class of restriction (COR) on the VoIP dial peers associated with directory numbers, use the cor command in voice register pool configuration mode. To disable a COR associated with directory numbers, use the no form of this command.
cor {incoming | outgoing} cor-list-name {cor-list-number starting-number [- ending-number] | default}
no cor {incoming | outgoing} cor-list-name {cor-list-number starting-number [- ending-number] | default}
Syntax Description
Command Default
None
Command Modes
Voice register pool configuration
Command History
Usage Guidelines
The cor command sets the dial-peer COR parameter for dynamically created VoIP dial peers. A list-based mechanism assigns COR parameters to specific set of number ranges. The COR functionality provides the ability to deny certain call attempts on the basis of the incoming and outgoing class of restrictions provisioned on the dial peers. This functionality provides flexibility in network design, allows users to block calls (for example, calls to 900 numbers), and applies different restrictions to call attempts from different originators.
COR specifies which incoming dial peer can use which outgoing dial peer to make a call. Each dial peer can be provisioned with an incoming and an outgoing COR list.
A default COR is assigned to the directory numbers that do not match any COR list number or number range. During Cisco Unified Session Initiation Protocol (SIP) Survivable Remote Site Telephony (SRST) registration, a dial peer is created and that dial peer includes a default COR value. The cor command allows you to change the automatically selected default.
In dial-peer configuration mode, build your COR list and add members. Then in voice register pool configuration mode, use the cor command to apply the name of the dial-peer COR list.
You can have up to four COR lists for the Cisco Unified SIP SRST configuration, comprised of incoming or outgoing dial peers. The first four COR lists are applied to a range of phone numbers. The phone numbers that do not have a COR list configuration are assigned to the default COR list, providing that a default COR list has been defined.
Note
Examples
The following is sample output from the show running-config command:
..voice register pool 1id mac 0030.94C2.A22Apreference 5cor incoming call91 1 91011translate-outgoing called 1proxy 10.2.161.187 preference 1 monitor probe icmp-pingalias 1 94... to 91011 preference 8voice-class codec 1...dial-peer cor customname 95name 94name 91!dial-peer cor list call91member 91!dial-peer voice 91500 potscorlist incoming call91corlist outgoing call91destination-pattern 91500port 1/0/0...Related Commands
corlist
This command was previously documented as the cor command.
To apply a class of restriction (COR) to the dial peers associated with a Cisco CME extension (ephone-dn), use the corlist command in ephone-dn configuration mode. To disable the COR associated with an extension, use the no form of this command.
corlist {incoming | outgoing} corlist-name
no corlist {incoming | outgoing}
Syntax Description
incoming
Specifies a COR list to be used by incoming dial peers.
outgoing
Specifies a COR list to be used by outgoing dial peers.
corlist-name
COR list name.
Command Default
No COR is used by the dial peers associated with the extension that is being configured.
Command Modes
Ephone-dn configuration
Command History
Usage Guidelines
COR is used to specify which incoming ephone-dn dial peer can use which outgoing ephone-dn dial peer to make a call. COR denies certain call attempts on the basis of the incoming and outgoing class of restrictions that have been provisioned on the dial peers. This functionality provides flexibility in network design, allows administrators to block calls (for example, calls to 900 numbers), and applies different restrictions to call attempts from different originators.
Each dial peer can be provisioned with an incoming and an outgoing COR list.
The corlist incoming and corlist outgoing commands in dial-peer configuration mode perform these functions for dial peers that are not associated with ephone-dns. The dial-peer cor list and member commands define the sets of capabilities, or COR lists, that are referred to in the corlist commands.
Examples
The following example shows how to set a COR parameter for incoming calls to dial peers associated with the extension that has the dn-tag 1:
Router(config)# ephone-dn 1Router(config-ephone-dn)# corlist incoming corlist1Related Commands
create cnf-files
To build the eXtensible Markup Language (XML) configuration files that are required for IP phones used with Cisco ITS V2.1, Cisco CME 3.0, Cisco Unified CME 4.0 or later versions, use the create cnf-files command in telephony-service configuration mode. To remove the configuration files and disable the automatic generation of configuration files, use the no form of this command.
create cnf-files
no create cnf-files
Syntax Description
This command has no arguments or keywords.
Command Default
Required XML configuration files are not built.
Command Modes
Telephony-service configuration
Command History
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.4(4)XC
Cisco Unified CME 4.0
The " Usage Guidelines" section was updated to describe the interaction of this command with new features.
Usage Guidelines
Use this command to build XML configuration files for Cisco IP phones during initial system setup. The XML files created by this command are located in an in-RAM file system at system:/its.
The no form of this command removes configuration files and disables automatic configuration file generation.
This command must be used after any of the following actions:
•
•
•
•
•
•
Examples
The following example builds the necessary XML configuration files on the Cisco Unified CME router:
Router(config)# telephony-serviceRouter(config-telephony)# create cnf-filesRelated Commands
create profile (voice register global)
To generate the configuration profile files required for SIP phones, use the create profile command in voice register global configuration mode. To return to the default, use the no form of this command.
create profile
no create profile
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Voice register global configuration
Command History
Usage Guidelines
This command generates the configuration files used for provisioning SIP phones and writes the files to the location specified with the tftp-path command.
Examples
The following example shows how to create the configuration profile:
Router(config)# voice register globalRouter(config-register-global)# mode cmeRouter(config-register-global)# create profileRelated Commands
credentials
To enter credentials configuration mode to configure a certificate for a Cisco Unified CME CTL provider or for Cisco Unified SRST router communication to Cisco Unified CallManager, use the credentials command in global configuration mode. To set all commands in credentials configuration mode to the default of nonsecure, use the no form of this command.
credentials
no credentials
Syntax Description
This command has no arguments or keywords.
Command Default
Credentials are not provided.
Command Modes
Global configuration
Command History
12.3(14)T
Cisco SRST 3.3
This command was introduced for Cisco SRST.
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced for Cisco Unified CME.
Usage Guidelines
This command is used to configure credentials service for Cisco Unified CME and Cisco Unified SRST.
Cisco Unified CME
This command is used with Cisco Unified CME phone authentication to configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running. That is, if there is a primary and a secondary Cisco Unified CME router and the CTL client is running on the primary router, a CTL provider must be configured on the secondary router, and vice versa. If the CTL client is running on a router that is not a Cisco Unified CME router, CTL providers must be configured on all Cisco Unified CME routers.
Credentials service for Cisco Unified CME runs on default port 2444.
Cisco Unified SRST
The credential server provides certificates to any device that requests a certificate. The credentials server does not request any data from a client; thus no authentication is necessary. When the client, Cisco Unified CallManager, requests a certificate, the credentials server provides the certificate. Cisco Unified CallManager exports the certificate to the phone, and the Cisco Unified IP phone holds the SRST router certificate in its configuration file. The device certificate for secure SRST routers is placed in the configuration file of the Cisco Unified IP phone because the entry limit in the certificate trust list (CTL) of Cisco Unified CallManager is 32.
Credentials service for SRST runs on default port 2445. Cisco Unified CallManager connects to port 2445 on the secure SRST router and retrieves the secure SRST device certificate during the TLS handshake.
Activate this command on all SRST routers.
Caution
Examples
Cisco Unified CME
The following example configures a CTL provider on the Cisco Unified CME router with the IP address 172.19.245.1. CTL providers must be configured on all Cisco Unified CME routers on which the CTL client is not running.
Router(config)# credentialsRouter(config-credentials)# ip source-address 172.19.245.1 port 2444Router(config-credentials)# trustpoint cmecaRouter(config-credentials)# ctl-service admin user4 secret 0 c89L8oCisco Unified SRST
The following example enters credentials configuration mode and sets the IP source address and the trustpoint:
Router(config)# credentialsRouter(config-credentials)# ip source-address 10.6.21.4 port 2445Router(config-credentials)# trustpoint srstcaRelated Commands
ctl-client
To enter CTL-client configuration mode to set parameters for the CTL client, use the ctl-client command in global configuration mode. To return to the default, use the no form of this command.
ctl-client
no ctl-client
Syntax Description
This command has no keywords or arguments.
Command Default
No CTL-client parameters are set.
Command Modes
Global configuration
Command History
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 with Cisco Unified CME phone authentication.
Examples
The following example defines server IP addresses and trustpoints for the CAPF server, the Cisco Unified CME router, and the TFTP server, as well as trustpoints for SAST1 and SAST2. It also specifies that a new CTL file should be generated.
Router(config)# ctl-clientRouter(config-ctl-client)# server capf 10.2.2.2 trustpoint capftrustRouter(config-ctl-client)# server cme 10.2.2.3 trustpoint cmetpRouter(config-ctl-client)# server tftp 10.2.2.4 trustpoint tftptpRouter(config-ctl-client)# sast1 trustpoint sast1tpRouter(config-ctl-client)# sast2 trustpoint sast2tpRouter(config-ctl-client)# regeneratectl-service admin
To specify a user name and password to authenticate the client during the CTL protocol, use the ctl-service admin command in credentials configuration mode. To return to the default, use the no form of this command.
ctl-service admin username secret {0 | 1} password-string
no ctl-service admin
Syntax Description
Command Default
No user name or password is defined for authentication.
Command Modes
Credentials configuration
Command History
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 with Cisco Unified CME phone authentication to define a user who will be used to authenticate the CTL client with a CTL provider.
Examples
The following example creates a CTL provider on a Cisco Unified CME router that is not running the CTL client.
Router(config)# credentials
Router(config-credentials)# ip source-address 172.19.245.1 port 2444
Router(config-credentials)# trustpoint ctlpv
Router(config-credentials)# ctl-service admin user4 secret 0 c89L8o
Related Commands
Posted: Thu Jul 19 11:07:23 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
