-
Cisco Unified Communications Manager Express Command Reference
-
Preface
-
Commands List by Config Mode
-
New, Modified, and Removed Commands in Cisco Unified CME 4.0 and Later
-
Cisco Unified CME Commands: A
-
Cisco Unified CME Commands: B
-
Cisco Unified CME Commands: C
-
Cisco Unified CME Commands: D
-
Cisco Unified CME Commands: Debug
-
Cisco Unified CME Commands: E
-
Cisco Unified CME Commands: F
-
Cisco Unified CME Commands: G
-
Cisco Unified CME Commands: H
-
Cisco Unified CME Commands: I
-
Cisco Unified CME Commands: K
-
Cisco Unified CME Commands: L
-
Cisco Unified CME Commands: M
-
Cisco Unified CME Commands: N
-
Cisco Unified CME Commands: O
-
Cisco Unified CME Commands: P
-
Cisco Unified CME Commands: R
-
Cisco Unified CME Commands: sast1 trustpoint through show fb-its-log
-
Cisco Unified CME Commands: show presence global through system message
-
Cisco Unified CME Commands: T
-
Cisco Unified CME Commands: U
-
Cisco Unified CME Commands: V
-
Cisco Unified CME Commands: W
-
Cisco Unified CME Commands: X
-
Table Of Contents
param dial-by-extension-option
param queue-overflow-extension
paramspace callsetup after-hours-exempt
pattern (voice register dialplan)
pattern trunk-to-ext no-answer
phone-redirect-limit (voice register global)
pin (voice logout-profile and voice user-profile)
preemption tone timer (voice MLPP)
preference (voice register dn)
preference (voice register pool)
privacy (voice register global)
privacy-button (voice register pool)
privacy-on-hold (voice register global)
protocol-mode (telephony-service)
Cisco Unified CME Commands: P
Revised: October 22, 2009This 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 references. Use the reference master index or search online to find these commands.
paging
To define an extension (ephone-dn) as a paging extension that can be called to broadcast an audio page to a set of Cisco IP phones, use the paging command in ephone-dn configuration mode. To disable this feature, use the no form of this command.
paging [ip multicast-address port udp-port-number]
no paging [ip]
Syntax Description
Command Default
No paging number is established.
Command Modes
Ephone-dn configuration (config-ephone-dn)
Command History
12.2(2)XT
Cisco ITS 2.0
This command was introduced.
12.2(8)T
Cisco ITS 2.0
This command was integrated into Cisco IOS Release 12.2(8)T.
Usage Guidelines
To configure a set of phones to receive an audio page, follow these steps:
1.
Use the paging command in ephone-dn configuration mode to define a number that people can dial to send a page. The following example defines a paging-dn tag (21) and extension number (34455) to dial to send a page.
ephone-dn 21pagingnumber 344552.
ephone 3paging-dn 21ephone 4paging-dn 21The paging command configures an ephone-dn as an extension that people can dial to broadcast audio pages to a specified set of idle Cisco IP phones. The extension associated with this command does not appear on any ephone; it is a "dummy" extension. The dn-tag associated with this extension becomes the paging-dn tag for this paging set.
When a person dials the number assigned to the dummy extension and speaks into the phone, the audio stream is sent as a page to the paging set (the set of all phones that have been configured with this paging-dn tag as an argument to the paging-dn command). Idle phones in the paging set automatically answer the paging call in one-way speakerphone mode. Paging sets can be joined into a single combined paging group with the paging group command.
The optional ip keyword and multicast-address argument define a paging multicast address for this paging set. If an IP multicast address is not configured, IP phones are paged individually using IP unicast transmission (to a maximum of ten IP phones). The recommended operation is with an IP multicast address. When multiple paging-dn tags are configured using the paging command, each paging-dn tag should use a unique IP multicast address.
Note
Each ephone-dn and paging-dn tag that is used for paging can support a maximum of ten distinct targets (IP addresses and interfaces). A multicast address counts as a single target for each physical interface in use (regardless of the number of phones connected via the interface). Paging using a single IP multicast address that requires output on three different Ethernet interfaces represents use of three counts out of the maximum ten. Each unicast target counts as a single target, such that paging that does not use multicast at all is limited to paging ten phones. For example, ten IP phones paged through multicast on Fast Ethernet interface 0/1.1 plus five IP phones paged through multicast on Fast Ethernet interface 0/1.2 are counted as two targets.
For simultaneous paging to more than one paging ephone-dn, Cisco recommends that you use different IP multicast addresses (not just different port numbers) for paging configuration.
Examples
The following example creates a paging extension number that uses IP multicast paging:
Router(config)# ephone-dn 20Router(config-ephone-dn) number 2000Router(config-ephone-dn) paging ip 239.0.1.1 port 2000A more complete configuration example follows, in which paging sets 20 and 21 are created. Pages to extension 2000 are multicast to ephones 1 and 2. Pages to extension 2001 are multicast to ephones 3 and 4.
ephone-dn 1
number 2345
ephone-dn 2
number 2346
ephone-dn 3
number 2347
ephone-dn 4
number 2348
ephone-dn 20
number 2000
paging ip 239.0.1.20 port 2000
ephone-dn 21
number 2001
paging ip 239.0.1.21 port 2000
ephone 1
button 1:1
paging-dn 20
ephone 2
button 1:2
paging-dn 20
ephone 3
button 1:3
paging-dn 21
ephone 4
button 1:4
paging-dn 21
Related Commands
paging-dn
Assigns audio paging reception capability to a Cisco IP phone.
paging group
Combines two or more paging sets into a combined paging group.
paging group
To create a combined paging group from two or more previously established paging sets, use the paging group command in ephone-dn configuration mode. To remove a paging group, use the no form of this command.
paging group paging-dn-tag, paging-dn-tag...
no paging group
Syntax Description
Command Default
Paging is disabled on all Cisco IP phones.
Command Modes
Ephone-dn configuration (config-ephone)
Command History
12.2(2)XT
Cisco ITS 2.0
This command was introduced.
12.2(8)T
Cisco ITS 2.0
This command was integrated into Cisco IOS Release 12.2(8)T.
Usage Guidelines
Use this command to combine previously defined sets of phones associated with individual paging extensions (ephone-dns) into a combined group to enable a single page to be sent to large numbers of phones at once. To remove a paging group, use the no form of the command. All paging-dn tags included in the list must have already been defined as paging-dns using the paging command.
The use of paging groups allows phones to participate in a small local paging set (for example, paging to four phones in a company's shipping and receiving department) but also supports company wide paging when needed (for example, by combining the paging sets for shipping and receiving with the paging sets for accounting, customer support, and sales into a single paging group).
Examples
In the following example, paging sets 20 and 21 are defined and then combined into paging group 22. Paging set 20 has a paging extension of 2000. When someone dials extension 2000 to deliver a page, the page is sent to Cisco IP phones (ephones) 1 and 2. Paging set 21 has a paging extension of 2001. When someone dials extension 2001 to deliver a page, the page is sent to ephones 3 and 4. Paging group 22 combines sets 20 and 21, and when someone dials its paging extension, 2002, the page is sent to all the phones in both sets and to ephone 5, which is directly subscribed to the combined paging group.
ephone-dn 20
number 2000
paging ip 239.0.1.20 port 2000
ephone-dn 21
number 2001
paging ip 239.0.1.21 port 2000
ephone-dn 22
number 2002
paging ip 239.0.2.22 port 2000
paging group 20,21
ephone 1
button 1:1
paging-dn 20
ephone 2
button 1:2
paging-dn 20
ephone 3
button 1:3
paging-dn 21
ephone 4
button 1:4
paging-dn 21
ephone 5
button 1:5
paging-dn 22
Related Commands
paging-dn
To create a paging extension (paging-dn) to receive audio pages on a Cisco Unified IP phone in a Cisco Unified CME system, use the paging-dn command in ephone or ephone-template configuration mode. To disable this feature, use the no form of this command.
paging-dn paging-dn-tag {multicast | unicast}
no paging-dn
Syntax Description
Command Default
Paging is disabled on all Cisco Unified IP phones.
Command Modes
Ephone configuration (config-ephone)
Ephone-template configuration (config-ephone-template)Command History
Usage Guidelines
To configure a set of phones to receive an audio page, follow these steps:
1.
ephone-dn 21pagingnumber 344552.
ephone 3paging-dn 21ephone 4paging-dn 21This command creates a paging extension (paging-dn) associated with an IP phone. Each phone can support only one paging-dn extension. This extension does not occupy a phone button and is therefore not configured on the phone with the button command. The paging-dn allows the phone to automatically answer audio pages in one-way speakerphone mode. There is no press-to-answer option as there is with an intercom extension.
The paging-dn-tag argument in this command takes the value of the dn-tag of an extension (ephone-dn) that has been made a paging ephone-dn using the paging command. This command is the extension that callers dial to deliver an audio page. All of the phones that are going to receive the same audio pages are configured with the same paging-dn-tag. These phones form a paging set.
An IP phone can belong to only one paging set, but any number of phones can belong to the same paging set using multicast. There can be any number of paging sets in a Cisco Unified CME system, and paging sets can be joined to create a combined paging group using the paging group command. For example, you may create separate paging sets for each department (sales, support, shipping) and combine them into a single combined paging group (all departments). Only single-level grouping is supported (no support for groups of groups).
Normal phone calls that are received while an audio page is in progress interrupt the page.
The paging mechanism supports audio distribution using IP multicast, replicated unicast, and a mixture of both (so that multicast is used where possible, and unicast is used with specific phones that cannot be reached through multicast).
Note
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 creates paging number 5001 on ephone-dn 22 and adds ephone 4 as a member of the paging set. Multicast is set for the paging-dn. Note that IP phones do not support multicast at 224.x.x.x addresses.
ephone-dn 1
number 5123
ephone-dn 22
name Paging Shipping
number 5001
paging ip 239.1.1.10 port 2000
ephone 4
mac-address 0030.94c3.8724
button 1:1
paging-dn 22 multicast
Related Commands
param aa-hunt
To declare a Cisco Unified CME B-ACD menu number and associate it with the pilot number of an ephone hunt group, use the param aa-hunt command in application-parameter configuration mode. To remove the menu number and the ephone hunt group pilot number, use the no form of this command.
param aa-huntmenu-number pilot-number
no param aa-huntmenu-number pilot-number
Syntax Description
menu-number
Number that callers must dial to reach the pilot number of an ephone hunt group. The range is from 1 to 10. The default is 1.
pilot-number
Ephone hunt group pilot number.
Command Default
Menu number 1 is configured, but it is not associated with a pilot number.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.4(4)XC
Cisco CME 3.3
This command was introduced to replace the call application voice aa-hunt command.
Usage Guidelines
This command is used with Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. It is configured under the service command for the call-queue script.
Up to ten aa-hunt menu options, or hunt groups, are allowed per call-queue service. You can use any of the allowable numbers in any order.
This command associates a menu option with the pilot number of an ephone hunt group. When a caller presses the digit of a menu option that has been associated with an ephone hunt group using this command, the call is routed to the pilot number of the hunt group.
Menu options for B-ACD services can be set up in many ways. For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
The highest aa-hunt number that you establish using this command also automatically maps to zero (0) and can therefore be used to represent operator services to your callers. In the following example, callers can dial either 8 or 0 to reach aa-hunt8, the hunt group with the pilot number 8888.
applicationservice queue flash:param aa-hunt1 1111param aa-hunt3 3333param aa-hunt8 8888For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
Examples
The following example configures a call-queue service called queue to associate three menu numbers with three pilot numbers of three ephone hunt groups:
•
•
•
If a caller presses 2 for customer service, the call is transferred to 2222 and then is sent to the next available ephone-dn from the group of ephone-dns assigned to ephone hunt group 1: 2001, 2002, 2003, 2004, 2005, and 2006. The sequencing of ephone-dns within a hunt group is handled by the ephone hunt group itself, not by the B-ACD service. (Note that the configuration for ephone hunt groups used with Cisco Unified CME B-ACD services do not use the final command.)
ephone-hunt 1 peer
pilot 1111
list 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010
ephone-hunt 2 peer
pilot 2222
list 2001, 2002, 2003, 2004, 2005, 2006
ephone-hunt 3 peer
pilot 3333
list 3001, 3002, 3003, 3004
application
service queue flash:
param aa-hunt1 1111
param aa-hunt2 2222
param aa-hunt3 3333
.
.
.
Related Commands
param aa-pilot
To assign a pilot number to a Cisco Unified CME B-ACD automated attendant (AA) service, use the param aa-pilot command in application-parameter configuration mode. To remove the AA pilot number, use the no form of this command.
param aa-pilot aa-pilot-number
no param aa-pilot aa-pilot-number
Syntax Description
Command Default
Cisco Unified CME B-ACD menu number 1 is configured, but it has no pilot number.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice aa-pilot command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. Each AA has one AA pilot number, although there may be more than one AA used with a B-ACD service.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets up a B-ACD with two AAs, both in drop-through mode. The first AA is called acdaa and it has an AA pilot number of (800) 555-0121. The second AA is aa-bcd and has an AA pilot number of (800) 555-0123. Both AAs use the call-queue service named callq. Incoming POTS dial peers are established for both AA pilot numbers.
dial-peer voice 1010 pots
service acdaa
port 1/1/0
incoming called-number 8005550121
dial-peer voice 1020 pots
service aa-bcd
port 1/1/1
incoming called-number 8005550123
.
.
.
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param aa-hunt2 5072
param number-of-hunt-grps 2
param queue-len 10
!
service acdaa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550121
param service-name callq
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 20
param number-of-hunt-grps 1
param drop-through-prompt _bacd_welcome.au
param drop-through-option 2
param second-greeting-time 45
param handoff-string acdaa
param max-time-call-retry 360
!
service aa-bcd tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550123
param service-name callq
param second-greeting-time 60
param max-time-call-retry 180
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 5
param handoff-string aa-bcd
param drop-through-option 1
param number-of-hunt-grps 1
Related Commands
param call-retry-timer
To specify the time interval before each attempt to retry to connect a call to an ephone hunt group used with a Cisco CME B-ACD service, use the param call-retry-timer command in application-parameter configuration mode. To return to the default, use the no form of this command.
param call-retry-timer seconds
no param call-retry-timer seconds
Syntax Description
seconds
Time that a call must wait before attempting or reattempting to transfer a call to an ephone hunt group pilot number, in seconds. Range is from 5 to 30 seconds.
Command Default
Default is 15 seconds.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice call-retry-timer command.
Usage Guidelines
This command is used with Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service. A Cisco Unified CME B-ACD service can have more than one AA, and each AA can specify a different interval for retries to connect to ephone hunt group phones.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets up a B-ACD with two AAs. The first AA is called acdaa and it has an AA pilot number of (800) 555-0121. The second AA is aa-bcd and has an AA pilot number of (800) 555-0123. Both AAs use the call-queue service named callq. The first AA has a call-retry timer set to 10 seconds, and the second AA has a call-retry timer set to 5 seconds.
dial-peer voice 1010 pots
service acdaa
port 1/1/0
incoming called-number 8005550121
dial-peer voice 1020 pots
service aa-bcd
port 1/1/1
incoming called-number 8005550123
.
.
.
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param aa-hunt2 5072
param number-of-hunt-grps 2
param queue-len 10
!
service acdaa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550121
param service-name callq
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 10
param number-of-hunt-grps 1
param drop-through-prompt _bacd_welcome.au
param drop-through-option 2
param second-greeting-time 45
param handoff-string acdaa
param max-time-call-retry 60
!
service aa-bcd tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550123
param service-name callq
param second-greeting-time 60
param max-time-call-retry 180
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 5
param handoff-string aa-bcd
param drop-through-option 1
param number-of-hunt-grps 1
Related Commands
param co-did-max
To set the upper boundary of the range of valid digits coming from the PSTN Central Office (CO) for use with the Direct Inward Dial (DID) Digit Translation Service, use the param co-did-max command in application-parameter configuration mode. To disable this option, use the no form of this command.
param co-did-max max-co-value
no param co-did-max max-co-value
Syntax Description
Command Default
No maximum value is defined for the range of digits coming from the CO.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command defines the upper limit of the range of digits accepted from the CO when it is used with the Cisco Unified CallManager Express (Cisco Unified CME) DID Digit Translation Service. This service provides number translation for DID calls when the range of DID digits provided by the PSTN Central Office (CO) does not match the digits in the Cisco Unified CME extension numbers.
The Tcl script that provides the service accepts PSTN DID numbers of any length and maps them to the internal extension numbers that are assigned by a system administrator. Where necessary, a prefix is appended to the DID digits to create a valid extension number. The script uses the parameters that you input to determine the valid range of digits to be accepted from the CO, the valid range of digits in the local dial plan, and the prefix to append, if necessary. The script also handles DID calls that map to invalid extension numbers: a prompt is played and the calls are disconnected.
Examples
The following example configures DID Digit Translation Service on the Cisco Unified CME router. It sets a lower boundary of 00 and an upper boundary of 79 for the valid range of digits coming from the CO.
application
service didapp tftp://192.168.254.254/scripts/did/app-THD-DID-2.0.0.1.tcl
paramspace english index 1
paramspace english language en
paramspace english location tftp://192.168.254.254/apps/dir25/
param secondary-prefix 4
param did-prefix 5
param co-did-min 00
param co-did-max 79
param store-did-min 00
param store-did-max 79
Related Commands
param co-did-min
To set the lower boundary of the range of valid digits coming from the PSTN Central Office (CO) that is used with the Direct Inward Dial (DID) Digit Translation Service, use the param co-did-min command in application-parameter configuration mode. To disable this option, use the no form of this command.
param co-did-min min-co-value
no param co-did-min min-co-value
Syntax Description
Command Default
No minimum value is defined for the range of digits coming from the CO.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command defines the upper limit of the range of digits accepted from the CO when it is used with the Cisco Unified CallManager Express (Cisco Unified CME) DID Digit Translation Service. This service provides number translation for DID calls when the range of DID digits provided by the PSTN Central Office (CO) does not match the digits in the Cisco Unified CME extension numbers.
The Tcl script that provides the service accepts PSTN DID numbers of any length and maps them to the internal extension numbers that are assigned by a system administrator. Where necessary, a prefix is appended to the DID digits to create a valid extension number. The script uses the parameters that you input to determine the valid range of digits to be accepted from the CO, the valid range of digits in the local dial plan, and the prefix to append, if necessary. The script also handles DID calls that map to invalid extension numbers: a prompt is played and the calls are disconnected.
Examples
The following example configures DID Digit Translation Service on the Cisco Unified CME router. It sets a lower boundary of 00 and an upper boundary of 79 for the valid range of digits coming from the CO.
application
service didapp tftp://192.168.254.254/scripts/did/app-THD-DID-2.0.0.1.tcl
paramspace english index 1
paramspace english language en
paramspace english location tftp://192.168.254.254/apps/dir25/
param secondary-prefix 4
param did-prefix 5
param co-did-min 00
param co-did-max 79
param store-did-min 00
param store-did-max 79
Related Commands
param dial-by-extension-option
To assign a menu number to an Cisco CME B-ACD option by which callers can directly dial known extension numbers, use the param dial-by-extension-option command in application-parameter configuration mode. To disable this option, use the no form of this command.
param dial-by-extension-option menu-number
no param dial-by-extension-option menu-number
Syntax Description
menu-number
Menu option number to be associated with the dial-by-extension option. Range is from 1 to 9. There is no default.
Command Default
Dial-by-extension option is not assigned.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice dial-by-extension-option command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
This command allows you to designate a menu option number for callers to press if they want to dial an extension number that they already know. This command also enables the playing of the en_bacd_enter_dest.au audio file after a caller presses the dial-by-extension menu number. The default announcement in this audio file is "Please enter the extension number you want to reach."
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets up a B-ACD with an AA called acd1, which has an AA pilot number of (800) 555-0121. The call-queue service used with this AA is named callq. Callers to (800) 555-0121 can press 1 to dial an extension number (param dial-by-extension-option 1 under service acd1) or press 2 to be connected to the hunt group with the pilot number 5072 (param aa-hunt2 5072 under service callq).
dial-peer voice 1010 pots
service acd1
port 1/1/0
incoming called-number 8005550121
.
.
.
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt2 5072
param number-of-hunt-grps 1
param queue-len 10
!
service acd1 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param handoff-string acd1
param service-name callq
param aa-pilot 8005550121
param number-of-hunt-grps 1
param dial-by-extension-option 1
param second-greeting-time 45
param call-retry-timer 20
param max-time-call-retry 360
param max-time-vm-retry 2
param voice-mail 5007
Related Commands
param did-prefix
To set a prefix to add to digits coming from the PSTN Central Office (CO) to create valid extension numbers when using the Direct Inward Dial (DID) Digit Translation Service, use the param did-prefix command in application-parameter configuration mode. To disable this option, use the no form of this command.
param did-prefix did-prefix
no param did-prefix did-prefix
Syntax Description
Command Default
No prefix is defined.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with the Cisco Unified CallManager Express (Cisco Unified CME) DID Digit Translation Service, which provides number translation for DID calls when the range of DID digits provided by the PSTN Central Office (CO) does not match the digits in the Cisco Unified CME extension numbers.
The Tcl script that provides the service accepts PSTN DID numbers of any length and maps them to the internal extension numbers that are assigned by a system administrator. Where necessary, a prefix is appended to the DID digits to create a valid extension number. The script uses the parameters that you input to determine the valid range of digits to be accepted from the CO, the valid range of digits in the local dial plan, and the prefix to append, if necessary. The script also handles DID calls that map to invalid extension numbers: a prompt is played and the calls are disconnected.
Examples
The following example configures DID Digit Translation Service on the Cisco Unified CME router. It specifies that a prefix of 5 should be applied to the digits coming from the CO in order to construct a valid extension number.
application
service didapp tftp://192.168.254.254/scripts/did/app-THD-DID-2.0.0.1.tcl
paramspace english index 1
paramspace english language en
paramspace english location tftp://192.168.254.254/apps/dir25/
param secondary-prefix 4
param did-prefix 5
param co-did-min 00
param co-did-max 79
param store-did-min 00
param store-did-max 79
Related Commands
param drop-through-option
To assign the drop-through option to a Cisco Unified CME B-ACD auto-attendant (AA) application, use the param drop-through option command in application-parameter configuration mode. To disable this option, use the no form of this command.
param drop-through-option menu-number
no param drop-through-option menu-number
Syntax Description
Command Default
Drop-through option is not assigned.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice drop-through-option command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
When an AA is configured for drop-through mode, the AA sends incoming calls directly to the call queue associated with the menu number specified in this command. Once in the queue, a caller hears ringback if an agent is available or music on hold (MOH) if all agents are busy. If a greeting prompt for drop-through mode is configured using the param drop-through-prompt command, a caller hears the prompt before being sent to the queue as described.
The menu option number is an aa-hunt number that is associated with an ephone hunt group using the param aa-hunt command.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets up a B-ACD with two AAs, both in drop-through mode. The first AA is called acdaa and it has an AA pilot number of (800) 555-0121. The second AA is aa-bcd and has an AA pilot number of (800) 555-0123. Both AAs use the call-queue service named callq. Callers to (800) 555-0121 drop directly through to the hunt group with the pilot number 5072 after hearing the greeting prompt in the audio file named en_dto_welcome.au. Callers to (800) 555-0123 drop directly through to the hunt group with the pilot number 5071 without hearing any greeting.
dial-peer voice 1010 pots
service acdaa
port 1/1/0
incoming called-number 8005550121
dial-peer voice 1020 pots
service aa-bcd
port 1/1/1
incoming called-number 8005550123
.
.
.
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param aa-hunt2 5072
param number-of-hunt-grps 2
param queue-len 10
!
service acdaa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550121
param service-name callq
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 20
param number-of-hunt-grps 1
param drop-through-prompt _bacd_dto_welcome.au
param drop-through-option 2
param second-greeting-time 45
param handoff-string acdaa
param max-time-call-retry 360
!
service aa-bcd tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550123
param service-name callq
param second-greeting-time 60
param max-time-call-retry 180
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 5
param handoff-string aa-bcd
param drop-through-option 1
param number-of-hunt-grps 1
Related Commands
param drop-through-prompt
To associate an audio prompt file with the drop-through option for a Cisco Unified CME B-ACD automated attendant (AA) application, use the param drop-through-prompt command in application-parameter configuration mode. To disable the prompt, use the no form of this command.
param drop-through-prompt audio-filename
no param drop-through-prompt audio-filename
Syntax Description
audio-filename
Identifying part of the filename of the prompt to be played when calls for the drop-through option are answered.
Command Default
No prompt is designated for the drop-through option.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice drop-through-prompt command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
When an AA is configured for drop-through mode, the AA sends incoming calls directly to the call queue associated with the menu number specified in this command. Once in the queue, a caller hears ringback if an agent is available or music on hold (MOH) if all agents are busy. If an greeting prompt for drop-through mode is configured, a caller hears the prompt before being sent to the queue as described.
The menu option number is an aa-hunt number that is associated with an ephone hunt group using the param aa-hunt command.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets up a B-ACD with two AAs, both in drop-through mode. The first AA is called acdaa and it has an AA pilot number of (800) 555-0121. The second AA is aa-bcd and has an AA pilot number of (800) 555-0123. Both AAs use the call-queue service named callq. Callers to (800) 555-0121 drop directly through to the hunt group with the pilot number 5072 after hearing the greeting prompt in the audio file named en_dto_welcome.au. (The prefix en is specified in the paramspace language command and is automatically added to the filename provided in the param drop-through-prompt command.) Callers to (800) 555-0123 drop directly through to the hunt group with the pilot number 5071 without hearing any greeting.
dial-peer voice 1010 pots
service acdaa
port 1/1/0
incoming called-number 8005550121
dial-peer voice 1020 pots
service aa-bcd
port 1/1/1
incoming called-number 8005550123
.
.
.
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param aa-hunt2 5072
param number-of-hunt-grps 2
param queue-len 10
!
service acdaa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550121
param service-name callq
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 20
param number-of-hunt-grps 1
param drop-through-prompt _bacd_dto_welcome.au
param drop-through-option 2
param second-greeting-time 45
param handoff-string acdaa
param max-time-call-retry 360
!
service aa-bcd tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550123
param service-name callq
param second-greeting-time 60
param max-time-call-retry 180
param max-time-vm-retry 2
param voice-mail 5007
param call-retry-timer 5
param handoff-string aa-bcd
param drop-through-option 1
param number-of-hunt-grps 1
Related Commands
param ea-password
To create a password for accessing the extension assigner application, use the param ea-password command in application-parameter configuration mode.
param ea-password password
Syntax Description
password
Numeric string to be used as password for the extension assigner application. Password string must be 2 to 10 characters long and can contain numbers 0 to 9.
Command Default
No password is created.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command creates a password for using the extension assigner application.
If this command is not configured, you cannot use the extension assigner application.
Note
Examples
The following example shows that a password (1234) is configured for the extension assigner application:
application
service EA flash:ea/app-cme-ea-2.0.0.0.tcl
paramspace english index 0
paramspace english language en
param ea-password 1234
paramspace english location flash:ea/
paramspace english prefix en
Related Commands
application
Enters application configuration mode.
service
Loads and configures a specific, standalone application on a dial peer.
param handoff-string
To specify the name of a Cisco Unified CME B-ACD auto-attendant (AA) to be passed to the call-queue script, use the param handoff-string command in application-parameter configuration mode. To disable the handoff string, use the no form of this command.
param handoff-string aa-service-name
no param drop-through-prompt aa-service-name
Syntax Description
Command Default
No string is designated to be passed to the call-queue service.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice handoff-string command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
The handoff string is used only when the call-queue script starts for the first time or restarts after a failure.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets parameters for an AA application called aa and a call-queue application called queue. The direct-dial number to reach the AA service is (800) 555-0100. Callers to this number drop through to the ephone hunt group that has a pilot number of 5071 after hearing the initial prompt from the file en_dt_prompt.au. The AA name, aa is passed to the call-queue service in the param handoff-string command.
dial-peer voice 1000 pots
service aa
port 1/1/0
incoming called-number 8005550100
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param number-of-hunt-grps 1
param queue-len 10
!
service aa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param number-of-hunt-groups 1
param service-name callq
param handoff-string aa
param second-greeting-time 60
param drop-through-option 1
param drop-through-prompt _dt_prompt.au
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
param max-extension-length
To specify the maximum number of digits callers can dial when they choose the dial-by-extension option from the Cisco Unified CME B-ACD service, use the param max-extension-length command in application-parameter configuration mode. To return to the default, use the no form of this command.
param max-extension-length number
no param max-extension-length number
Syntax Description
Command Default
The default number of digits callers can dial using the dial-by-extension option is 5.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice max-extension-length command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
Use this command to restrict the number of digits that callers can dial when using the dial-by-extension option.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets parameters for an AA application called aa and a call-queue application called queue. The direct-dial number to reach the AA service is (800) 555-0100. Callers to this number can press 1 to be connected to the ephone hunt group with the pilot number 5071 or can press 2 to dial an extension number of 4 or fewer digits.
dial-peer voice 1000 pots
service aa
port 1/1/0
incoming called-number 8005550100
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param number-of-hunt-grps 1
param queue-len 10
!
service aa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param welcome-prompt _aa_welcome.au
param number-of-hunt-groups 1
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
param max-time-call-retry
To specify the maximum length of time for which calls to the Cisco Unified CME B-ACD service can stay in a call queue, use the param max-time-call-retry command in application-parameter configuration mode. To return to the default, use the no form of this command.
param max-time-call-retry seconds
no param max-time-call-retry
Syntax Description
seconds
Maximum length of time that the call-queue service can keep redialing a hunt group pilot number, in seconds. Range: 20 to 3600. Default: 600.
Command Default
A call in a B-ACD call queue continues to try to connect to a hunt group for 600 seconds.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) service. Configure this command under the service command for an AA service.
A call to a Cisco Unified CME B-ACD service is put into a call queue if the hunt group that the call tried to reach has no phones available to take the call because they are all busy. While the call is in the queue, a second greeting is played at intervals specified by the param second-greeting-time command. From the queue, the call makes retries to connect at intervals specified by the param call-retry-timer command until the maximum amount of time to be spent in the queue expires. The maximum amount of time is set by the param max-time-call-retry command. After the maximum amount of time expires, the call is routed to the alternate destination specified in the param voice-mail command. If the alternate destination number is busy, the call makes the number of retries to connect specified in the param max-time-vm-retry command. If the call is unable to connect to the alternate destination after the number of retries that has been specified, it is disconnected.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For configuration information, see the "Setting Up Call-Queue and AA Services" section in the Cisco Unified CME B-ACD and Tcl Call-Handling Applications document.
Examples
The following example sets parameters for an AA application called aa and a call-queue application called queue. The direct-dial number to reach the AA service is (800) 555-0100. Callers to this number can press 1 to be connected to the ephone hunt group with the pilot number 5071 or can press 2 to dial an extension number of 4 or fewer digits.
If a caller presses 2 and all the phones in ephone-hunt group 10 are busy, the call is put into a queue for hunt group 10. Every 60 seconds, the caller hears the second greeting, which is "Please continue to hold. An agent will be with you shortly." Every 15 seconds, the call-queue service tries again to connect the call to the hunt group. If no phones become available before 700 seconds expire, the call is routed to extension 5000. If that extension is busy, the call-queue service retries it 2 times more. If the call still cannot be connected, it is disconnected.
dial-peer voice 1000 pots
service aa
port 1/1/0
incoming called-number 8005550100
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param number-of-hunt-grps 1
param queue-len 10
!
service aa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param welcome-prompt _aa_welcome.au
param number-of-hunt-groups 1
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
param max-time-vm-retry
To specify the maximum number of times that calls in a Cisco Unified CME B-ACD call queue can attempt to connect to the alternate destination number, use the param max-time-vm-retry command in application-parameter configuration mode. To return to the default, use the no form of this command.
param max-time-vm-retry number
no param max-time-vm-retry number
Syntax Description
number
Number of times that the alternate destination number is redialed by the call-queue service. Range is from 1 to 3. Default is 1.
Command Default
A call in a B-ACD call queue tries to connect to an alternate destination number 1 time.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice max-time-vm-retry command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
A call to a Cisco Unified CME B-ACD service is put into a call queue if the hunt group that the call tried to reach has no phones available to take the call because they are all busy. While the call is in the queue, a second greeting is played at intervals specified by the param second-greeting-time command. From the queue, the call makes retries to connect at intervals specified by the param call-retry-timer command until the maximum amount of time to be spent in the queue expires. The maximum amount of time is set by the param max-time-call-retry command. After the maximum amount of time expires, the call is routed to the alternate destination specified in the param voice-mail command. If the alternate destination number is busy, the call makes the number of retries to connect specified in the param max-time-vm-retry command. If the call is unable to connect to the alternate destination after the number of retries that has been specified, it is disconnected.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets parameters for an AA application called aa and a call-queue application called queue. The direct-dial number to reach the AA service is (800) 555-0100. Callers to this number can press 1 to be connected to the ephone hunt group with the pilot number 5071 or can press 2 to dial an extension number of 4 or fewer digits.
If a caller presses 2 and all the phones in ephone-hunt group 10 are busy, the call is put into a queue for hunt group 10. Every 60 seconds, the caller hears the second greeting, which is "Please continue to hold. An agent will be with you shortly." Every 15 seconds, the call-queue service tries again to connect the call to the hunt group. If no phones become available before 700 seconds expire, the call is routed to extension 5000. If that extension is busy, the call-queue service retries it 2 times more. If the call still cannot be connected, it is now disconnected.
dial-peer voice 1000 pots
service aa
port 1/1/0
incoming called-number 8005550100
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param number-of-hunt-grps 1
param queue-len 10
!
service aa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param welcome-prompt _aa_welcome.au
param number-of-hunt-groups 1
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
param menu-timeout
To set the number of times the AA service will loop the menu prompt before connecting the caller to an operator if the caller does not select a menu option, use the param menu-timeout command in application-parameter configuration mode. To return to the default, use the no form of this command.
param menu-timeout number
no param menu-timeout
Syntax Description
number
Times to replay menu prompt before connecting a caller to an operator. Range: 0 to 10. Default: 4.
Command Default
Auto-attendant service replays menu prompt 4 times before connecting the caller to an operator.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with Cisco Unified CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) service.
If a caller does not select a menu option before the timeout set with this command expires, the call is transferred to the operator hunt group. The operator hunt-group is the hunt group with the highest aa-hunt number set with the param aa-hunt command.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For configuration information, see the "Setting Up Call-Queue and AA Services" section in the Cisco Unified CME B-ACD and Tcl Call-Handling Applications document.
Examples
The following example shows the menu timeout set to 5 replays for the AA application called order1-aa:
application
service acme-aa1 tftp://192.168.254.254/acme/bacd/app-b-acd-aa-2.1.2.3.tcl
paramspace english index 1
param menu-timeout 5
param handoff-string acme-aa1
param dial-by-extension-option 2
paramspace english language en
param max-time-vm-retry 2
param max-extension-length 4
param aa-pilot 8005550100
paramspace english location flash:/bacd/
param second-greeting-time 60
param welcome-prompt _aa_welcome.au
param number-of-hunt-groups 1
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param service-name callq
Related Commands
param number-of-hunt-grps
To specify the number of hunt groups used with a Cisco Unified CME B-ACD call-queue or AA service, use the param number-of-hunt-grps command in application-parameter configuration mode. To return to the default, use the no form of this command.
param number-of-hunt-grps number
no param number-of-hunt-grps number
Syntax Description
number
Number of ephone hunt groups used by the service. Range is 1 to 10 for the call-queue service and 1 to 3 for an automated attendant (AA) service.
Command Default
This parameter is not set.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice number-of-hunt-grps command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured both under the service command for the call-queue service and under the service command for an AA service.
The number of hunt groups specified for the call-queue service is the total of the number of hunt groups used with all the AAs with which it is associated. For example, if a B-ACD has three AAs, each with two hunt groups, the number of hunt groups for each AA is two and the number of hunt groups for the call-queue service is six.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
A call-queue service called CQ is set up to work with two AA services. CQ lists 4 as the number of hunt groups it uses. AA1 is associated with 3 hunt groups, and its callers hear the following prompt: "Press 1 for sales, press 2 for service, press 0 for operator." AA2 uses drop-through mode. Its callers do not hear a prompt and are directly connected to the single hunt group that is associated with it.
application
service CQ tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 1001
param aa-hunt2 2001
param aa-hunt3 3001
param aa-hunt4 4001
param number-of-hunt-grps 4
param queue-len 10
service AA1 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550111
param number-of-hunt-groups 3
param service-name CQ
param welcome-prompt _bacd_welcome.au
param handoff-string AA1
service AA2 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550122
param number-of-hunt-groups 1
param service-name CQ
param drop-through-option 4
param handoff-string AA2
Related Commands
param queue-exit-extension
To assign an extension number to a call-queue exit option, use the param queue-exit-extension command in application-parameter configuration mode. To remove an exit option, use the no form of this command.
param queue-exit-extensionoption-number extension-number
no param queue-exit-extensionoption-number
Syntax Description
option-number
Number of the call-queue exit option. Range: 1 to 3. There is no default.
extension-number
Extension number associated with the exit option.
Command Default
Call-queue exit option is not defined.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) service.
Use this command together with the param queue-exit-option command to enable callers to select from up to three different options to exit from a call queue. The option-number argument in this command corresponds to the option-number argument in the param queue-exit-option command.
You can record a customized second greeting that offers callers up to three options to exit from the call queue. For example, you might record a message that says, "To leave a message, press 6; to hear more options, press 7; to speak to an operator, press 8."
This second greeting is stored in the audio file named en_bacd_allagentsbusy.au. You can record over the default message in this file, provided you do not change the name of the file.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For configuration information, see the "Setting Up Call-Queue and AA Services" section in the Cisco Unified CME B-ACD and Tcl Call-Handling Applications document.
Examples
The following example shows that the acme-aa1 application has three exit options defined for its call-queue service:
application
service acme-aa1 tftp://192.168.254.254/acme/bacd/app-b-acd-aa-2.1.2.3.tcl
param dial-by-extension-option 7
param handoff-string acme-aa1
paramspace english index 1
param queue-exit-option2 7
param max-time-vm-retry 2
paramspace english language en
param aa-pilot 801
param max-extension-length 4
param queue-overflow-extension 101
param queue-exit-extension2 101
param second-greeting-time 20
param queue-exit-option1 6
paramspace english location flash:/bacd/
param send-account true
param call-retry-timer 20
param queue-exit-option3 8
param voice-mail 444
param max-time-call-retry 60
param service-name sf-queue
param queue-exit-extension1 202
param number-of-hunt-grps 1
param drop-through-option 1
param queue-exit-extension3 444
Related Commands
param queue-exit-option
To assign a menu number to a call-queue exit option, use the param queue-exit-option command in application-parameter configuration mode. To disable this option, use the no form of this command.
param queue-exit-optionoption-number menu-number
no param queue-exit-optionoption-number
Syntax Description
option-number
Number of the call-queue exit option. Range: 1 to 3. There is no default.
menu-number
Menu option number associated with the exit option.
Command Default
Call-queue exit option is not assigned.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) service.
Use this command together with the param queue-exit-extension command to enable callers to select from up to three different options to exit from a call queue. The option-number argument in this command corresponds to the option-number argument in the param queue-exit-extension command.
You can record a customized second greeting that offers callers up to three options to exit from the call queue. For example, you might record a message that says, "To leave a message, press 6; to hear more options, press 7; to speak to an operator, press 8."
This second greeting is stored in the audio file named en_bacd_allagentsbusy.au. You can record over the default message in this file, provided you do not change the name of the file.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For configuration information, see the "Setting Up Call-Queue and AA Services" section in the Cisco Unified CME B-ACD and Tcl Call-Handling Applications document.
Examples
The following example shows that the acme-aa1 application has three exit options defined for its call-queue service:
application
service acme-aa1 tftp://192.168.254.254/acme/bacd/app-b-acd-aa-2.1.2.3.tcl
param dial-by-extension-option 7
param handoff-string acme-aa1
paramspace english index 1
param queue-exit-option2 7
param max-time-vm-retry 2
paramspace english language en
param aa-pilot 801
param max-extension-length 4
param queue-overflow-extension 101
param queue-exit-extension2 101
param second-greeting-time 20
param queue-exit-option1 6
paramspace english location flash:/bacd/
param send-account true
param call-retry-timer 20
param queue-exit-option3 8
param voice-mail 444
param max-time-call-retry 60
param service-name sf-queue
param queue-exit-extension1 202
param number-of-hunt-grps 1
param drop-through-option 1
param queue-exit-extension3 444
Related Commands
param queue-len
To specify the number of calls that can be held in each call queue in a Cisco Unified CME B-ACD service, use the param queue-len command in application-parameter configuration mode. To return to the default, use the no form of this command.
param queue-len number
no param queue-len number
Syntax Description
Command Default
The default queue length is 10.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice queue-len command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for a call-queue service.
This command specifies the maximum number of calls that can be held in a call queue for a hunt group used with B-ACD when all of the hunt group member phones are busy.
Note that having calls in queue keeps PSTN ports occupied for a longer time, and you may want to plan for more ports if you have longer queues. 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 have 20 foreign exchange office (FXO) ports and two ephone hunt groups, you can configure a maximum of ten calls per ephone hunt-group queue using the param queue-len 10 command. You can use the same configuration if you have a single T1 trunk, which supports 23 channels.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
A call-queue service called CQ is set up to work with two AA services. CQ lists four as the number of hunt groups it uses. AA1 is associated with three hunt groups, and its callers hear the following prompt: "Press 1 for sales, press 2 for service, press 0 for operator." AA2 uses drop-through mode. Its callers do not hear a prompt and are directly connected to the single hunt group that is associated with it. Up to 12 calls can be held in the call queue for each hunt group if all the phones in the hunt group are busy.
application
service CQ tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 1001
param aa-hunt2 2001
param aa-hunt3 3001
param aa-hunt4 4001
param number-of-hunt-grps 4
param queue-len 12
service AA1 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550111
param number-of-hunt-groups 3
param service-name CQ
param welcome-prompt _bacd_welcome.au
param handoff-string AA1
service AA2 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550122
param number-of-hunt-groups 1
param service-name CQ
param drop-through-option 4
param handoff-string AA2
Related Commands
param queue-overflow-extension
To set the extension number to route calls to when the call queue for the auto-attendant service is full, use the param queue-overflow-extension command in application-parameter configuration mode. To return to the default, use the no form of this command.
param queue-overflow-extension extension-number
no param queue-overflow-extension
Syntax Description
extension-number
Extension number to which the auto-attendant service forwards calls when the call queue is full.
Command Default
No overflow extension is defined. Calls disconnect if the queue becomes full.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) service.
This command specifies the extension number where calls are sent when the number of calls waiting in a B-ACD call queue exceeds the number set with the param queue-len command.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For configuration information, see the "Setting Up Call-Queue and AA Services" section in the Cisco Unified CME B-ACD and Tcl Call-Handling Applications document.
Examples
The following example shows that the AA application named acme-aa1 uses the call-queue service named CQ. When the number of calls in the queue exceeds 12, new calls that cannot be answered by an agent are sent to extension 5100.
application
service CQ tftp://192.168.254.254/acme/bacd/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 1001
param aa-hunt2 2001
param aa-hunt3 3001
param aa-hunt4 4001
param number-of-hunt-grps 4
param queue-len 12
!
!
applicationservice acme-aa1 tftp://192.168.254.254/acme/bacd/app-b-acd-aa-2.1.2.3.tclparamspace english index 1param handoff-string acme-aa1param dial-by-extension-option 2paramspace english language enparam aa-pilot 8005550100param queue-overflow-extension 5100paramspace english location flash:/bacd/param welcome-prompt _aa_welcome.auparam number-of-hunt-groups 1param voice-mail 5000param service-name CQRelated Commands
param queue-manager-debugs
To enable the collection of call-queue debug information in a Cisco Unified CME B-ACD service, use the param queue-manager-debugs command in application-parameter configuration mode. To remove the setting, use the no form of this command with the keyword that was previously used.
param queue-manager-debugs [0 | 1]
no param queue-manager-debugs [0 | 1]
Syntax Description
0
Disables collection of call-queue debug information.
1
Enables collection of call-queue debug information
Command Default
Collection of debug information is disabled.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice queue-manager-debugs command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for the call-queue service.
This command 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 Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
A call-queue service called CQ is set up to work with two AA services. CQ lists four as the number of hunt groups it uses. AA1 is associated with three hunt groups, and its callers hear the following prompt: "Press 1 for sales, press 2 for service, press 0 for operator." AA2 uses drop-through mode. Its callers do not hear a prompt and are directly connected to the single hunt group that is associated with it. Up to ten calls can be held in the call queue for each hunt group if all the phones in the hunt group are busy with other calls. Call-queue debugging is enabled.
application
service CQ tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 1001
param aa-hunt2 2001
param aa-hunt3 3001
param aa-hunt4 4001
param number-of-hunt-grps 4
param queue-len 10
service AA1 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550111
param number-of-hunt-groups 3
param service-name CQ
param welcome-prompt _bacd_welcome.au
param handoff-string AA1
service AA2 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550122
param number-of-hunt-groups 1
param service-name CQ
param drop-through-option 4
param handoff-string AA2
Related Commands
param secondary-prefix
To set a prefix to add to digits coming from the PSTN Central Office (CO) to route calls from a secondary Cisco Unified CME router to a primary Cisco Unified CME router when using the Direct Inward Dial (DID) Digit Translation Service, use the param secondary-prefix command in application-parameter configuration mode. To disable this option, use the no form of this command.
param secondary-prefix secondary-prefix
no param secondary-prefix secondary-prefix
Syntax Description
secondary-prefix
Prefix to add to digits in order to route calls to the primary Cisco Unified CME router. Range is from 0 to 99.
Defaults
No prefix is defined.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command is used with the Cisco Unified CallManager Express (Cisco Unified CME) DID Digit Translation Service, which provides number translation for DID calls when the range of DID digits provided by the PSTN Central Office (CO) does not match the digits in the Cisco Unified CME extension numbers.
The Tcl script that provides the service accepts PSTN DID numbers of any length and maps them to the internal extension numbers that are assigned by a system administrator. Where necessary, a prefix is appended to the DID digits to create a valid extension number. The script uses the parameters that you input to determine the valid range of digits to be accepted from the CO, the valid range of digits in the local dial plan, and the prefix to append, if necessary. The script also handles DID calls that map to invalid extension numbers: a prompt is played and the calls are disconnected.
When calls are received by a secondary Cisco Unified CME router, they are routed to the primary router by configuring an H.323 VoIP dial peer and matching the destination pattern for that dial peer. The DID prefix that was configured for use with the DID script is appended to the incoming DID digits first. The secondary prefix is appended next. For example, if the incoming DID digits are 25, the DID prefix is 3, and the secondary prefix is 7, the transformed number will be 7325. The transformed number matches a VoIP dial peer, which uses the forward-digits command to send only the three relevant digits, the extension number, to the primary router.
See the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example configures a Basic DID application on the Cisco Unified CME router. It sets a prefix of 5 to apply to the digits coming from the CO in order to construct a valid extension number. Then the secondary prefix (4) is appended. If the incoming DID digits are 25, the DID prefix is 5, and the secondary prefix is 4, then the transformed number is 4525. The transformed number matches VoIP dial peer 1000. The VoIP dial peer sends calls to the primary Cisco Unified CME router using the IP address that is entered in the session target command. The dial peer uses the forward-digits command to send the extension number, 525, to the primary Cisco Unified CME router.
dial-peer voice 1000 voip
destination-pattern 45..
session target ipv4:10.1.1.1
dtmf-relay h245-alphanumeric
codec g711ulaw
forward-digits 3
application
service didapp tftp://192.168.254.254/scripts/did/app-THD-DID-2.0.0.1.tcl
paramspace english index 1
paramspace english language en
paramspace english location tftp://192.168.254.254/apps/dir25/
param secondary-prefix 4
param did-prefix 5
param co-did-min 00
param co-did-max 79
param store-did-min 00
param store-did-max 79
Related Commands
param second-greeting-time
To set the length of the intervals between playouts of the second greeting to calls waiting in hunt group call queues that are part of a Cisco Unified CME B-ACD service, use the param second-greeting-time command in application-parameter configuration mode. To return to the default, use the no form of this command
param second-greeting-time seconds
no param max-time-vm-retry seconds
Syntax Description
seconds
Length of time intervals between playouts of the second greeting to calls in a B-ACD call queue, in seconds. Range is from 30 to 120. Default is 60.
Command Default
The second greeting is played out every 60 seconds to calls in B-ACD call queues.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice second-greeting-time command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
A call to a Cisco Unified CME B-ACD service is put into a call queue if the hunt group that the call tried to reach has no phones available to take the call because they are all busy. While the call is in the queue, a second greeting is played at intervals specified by the param second-greeting-time command. From the queue, the call retries to connect to the hunt group at intervals specified by the param call-retry-timer command until the maximum amount of time to be spent in the queue expires. The maximum amount of time is set by the param max-time-call-retry command. After the maximum amount of time expires, the call is routed to the alternate destination specified in the param voice-mail command. If the alternate destination number is busy, the call makes the number of retries to connect specified in the param max-time-vm-retry command. If the call is unable to connect to the alternate destination after the number of retries that has been specified, it is disconnected.
The second greeting is stored in the audio file named en_bacd_allagentsbusy.au. You can rerecord over the default message that is provided in the file, but you cannot change the name of the file.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets parameters for an AA application called aa and a call-queue application called queue. The direct-dial number to reach the AA service is (800) 555-0100. Callers to this number can press 1 to be connected to the ephone hunt group with the pilot number 5071 or can press 2 to dial an extension number of 4 or fewer digits.
If a caller presses 2 and all the phones in ephone-hunt group 10 are busy, the call is put into a queue for hunt group 10. Every 60 seconds, the caller hears the second greeting, which is "Please continue to hold. An agent will be with you shortly." Every 15 seconds, the call-queue service tries again to connect the call to the hunt group. If no phones become available before 700 seconds expire, the call is routed to extension 5000. If that extension is busy, the call-queue service retries it 2 times more. If the call still cannot be connected, it is now disconnected.
dial-peer voice 1000 pots
service aa
port 1/1/0
incoming called-number 8005550100
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param number-of-hunt-grps 1
param queue-len 10
!
service aa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param welcome-prompt _aa_welcome.au
param number-of-hunt-groups 1
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
param send-account true
To generate call detail records (CDRs) for calls that are handled by the Cisco Unified CME B-ACD service, use the param send-account command in application-parameter configuration mode. To return to the default, use the no form of this command.
param send-account true
no param send-account true
Syntax Description
This command has no arguments or keywords.
Command Default
CDRs are not generated.
Command Modes
Application-parameter configuration (config-app-param)
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 captures CDRs in RADIUS format for calls handled by the Cisco Unified CME Basic Automatic Call Distribution (B-ACD) and Auto-Attendant (AA) service. The call record includes the name of the AA service, hunt group pilot-number, and globally unique identifier (GUID).
For configuration information, see the "Setting Up Call-Queue and AA Services" section in the Cisco Unified CME B-ACD and Tcl Call-Handling Applications document.
For information on enabling RADIUS accounting, see the CDR Accounting for Cisco IOS Voice Gateways guide.
Examples
The following example shows that calls using the acme-aa1 service generate a call detail record:
application
service acme-aa1 tftp://192.168.254.254/acme/bacd/app-b-acd-aa-2.1.2.3.tcl
paramspace english index 1
param handoff-string acme-aa1
param dial-by-extension-option 2
paramspace english language en
param aa-pilot 8005550100
paramspace english location flash:/bacd/
param welcome-prompt _aa_welcome.au
param send-account true
param number-of-hunt-groups 1
param voice-mail 5000
param service-name callq
Related Commands
param service-name
To specify a Cisco Unified CME B-ACD call-queue service to use with an automated attendant (AA) service, use the param service-name command in application-parameter configuration mode. To return to the default, use the no form of this command.
param service-name queue-service-name
no param service-name queue-service-name
Syntax Description
Command Default
No call-queue service is specified.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice service-name command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information, the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
A call-queue service called CQ is set up to work with two AA services. CQ lists four as the number of hunt groups it uses. AA1 is associated with three hunt groups, and its callers hear the following prompt: "Press 1 for sales, press 2 for service, press 0 for operator." AA2 uses drop-through mode. Its callers do not hear a prompt and are directly connected to the single hunt group that is associated with it. Up to ten calls can be held in the call queue for each hunt group if all the phones in the hunt group are busy with other calls. Call-queue debugging is enabled.
application
service CQ tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 1001
param aa-hunt2 2001
param aa-hunt3 3001
param aa-hunt4 4001
param number-of-hunt-grps 4
param queue-len 10
service AA1 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550111
param number-of-hunt-groups 3
param service-name CQ
param welcome-prompt _bacd_welcome.au
param handoff-string AA1
service AA2 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550122
param number-of-hunt-groups 1
param service-name CQ
param drop-through-option 4
param handoff-string AA2
Related Commands
param store-did-max
To set the upper boundary of the range of digits that is valid in the Cisco Unified CME numbering plan used with the Direct Inward Dial (DID) Digit Translation Service, use the param store-did-max command in global configuration mode. To disable this option, use the no form of this command.
param store-did-max max-store-value
no param store-did-max max-store-value
Syntax Description
Command Default
No maximum value is defined for the range of digits in the dial plan.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command defines the upper limit of the range of digits in the site dial plan for the Cisco Unified CallManager Express (Cisco Unified CME) Direct Inward Dial Digit Translation Service, which provides number translation for DID calls when the DID digits provided by the PSTN Central Office (CO) do not match the digits in the Cisco Unified CME extension numbers.
The Tcl script that provides the service accepts PSTN DID numbers of any length and maps them to the internal extension numbers that are assigned by a system administrator. Where necessary, a prefix is appended to the DID digits to create a valid extension number. The script uses the parameters that you input to determine the valid range of digits to be accepted from the CO, the valid range of digits in the local dial plan, and the prefix to append, if necessary. The script also handles DID calls that map to invalid extension numbers. A prompt is played and the calls are disconnected.
Examples
The following example configures Direct Inward Dial Digit Translation Service on the Cisco Unified CME router. It sets a lower boundary of 00 and an upper boundary of 79 for the range of digits in the Cisco Unified CME extension dial plan. Notice that the length of the digit string is the same (2 digits) for all related commands.
application
service didapp tftp://192.168.254.254/scripts/did/app-THD-DID-2.0.0.1.tcl
paramspace english index 1
paramspace english language en
paramspace english location tftp://192.168.254.254/apps/dir25/
param secondary-prefix 4
param did-prefix 5
param co-did-min 00
param co-did-max 79
param store-did-min 00
param store-did-max 79
Related Commands
param store-did-min
To set the lower boundary of the range of digits that is valid in the Cisco Unified CME numbering plan used with the Direct Inward Dial (DID) Digit Translation Service, use the param store-did-min command in application-parameter configuration mode. To disable this option, use the no form of this command.
param store-did-min min-store-value
no param store-did-min min-store-value
Syntax Description
Command Default
No minimum value is defined for the range of digits in the dial plan.
Command Modes
Application-parameter configuration (config-app-param)
Command History
Usage Guidelines
This command defines the lower limit of the range of digits in the site dial plan when it is used with the Cisco Unified CallManager Express (Cisco Unified CME) DID Digit Translation Service. This service provides number translation for DID calls when the range of DID digits provided by the PSTN Central Office (CO) does not match the digits in the Cisco Unified CME extension numbers.
The Tcl script that provides the service accepts PSTN DID numbers of any length and maps them to the internal extension numbers that are assigned by a system administrator. Where necessary, a prefix is appended to the DID digits to create a valid extension number. The script uses the parameters that you input to determine the valid range of digits to be accepted from the CO, the valid range of digits in the local dial plan, and the prefix to append, if necessary. The script also handles DID calls that map to invalid extension numbers: a prompt is played and the calls are disconnected.
Examples
The following example configures DID Digit Translation Service on the Cisco Unified CME router. It sets a lower boundary of 00 and an upper boundary of 79 for the range of digits in the Cisco Unified CME extension dial plan.
application
service didapp tftp://192.168.254.254/scripts/did/app-THD-DID-2.0.0.1.tcl
paramspace english index 1
paramspace english language en
paramspace english location tftp://192.168.254.254/apps/dir25/
param secondary-prefix 4
param did-prefix 5
param co-did-min 00
param co-did-max 79
param store-did-min 00
param store-did-max 79
Related Commands
param voice-mail
To set an alternate destination number to which to route calls that cannot be connected to a hunt group that is part of a Cisco Unified CME B-ACD service, use the param voice-mail command in application-parameter configuration mode. To return to the default, use the no form of this command
param voice-mail number
no param voice-mail number
Syntax Description
number
Extension number to which to route calls. The number must be associated with a dial peer that is reachable by the Cisco Unified CME system.
Command Default
No alternate destination number is set.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice voice-mail command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
Calls are diverted to an alternate destination only when one of the following criteria is met:
•
•
The alternate destination can be any number at which you can assure call coverage, such as a voice-mail number, a permanently staffed number, or a number that rings an overhead night bell. Once a call is diverted to an alternate destination, it is no longer controlled by the B-ACD service. This parameter is set with the param voice-mail command.
If you send calls to a voice-mail system as an alternate destination, be sure to set up the voice-mail system as specified in the documentation for the system.
If you specify a number for an alternate destination, the number must be associated with a dial peer that is reachable by the Cisco Unified CME system.
For any configuration changes to take effect, you must reload the Cisco Unified CME B-ACD scripts.
For more information about B-ACD, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets parameters for an AA application called aa and a call-queue application called queue. The direct-dial number to reach the AA service is (800) 555-0100. Callers to this number can press 1 to be connected to the ephone hunt group with the pilot number 5071 or can press 2 to dial an extension number of 4 or fewer digits.
If a caller presses 2 and all the phones in ephone-hunt group 10 are busy, the call is put into a queue for hunt group 10. Every 60 seconds, the caller hears the second greeting, which is "Please continue to hold. An agent will be with you shortly." Every 15 seconds, the call-queue service tries again to connect the call to the hunt group. If no phones become available before 700 seconds expire, the call is routed to extension 5000, which is the alternate destination. If that extension is busy, the call-queue service retries it 2 times more. If the call still cannot be connected, it is disconnected.
dial-peer voice 1000 pots
service aa
port 1/1/0
incoming called-number 8005550100
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param number-of-hunt-grps 1
param queue-len 10
!
service aa tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param welcome-prompt _aa_welcome.au
param number-of-hunt-groups 1
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
param welcome-prompt
To specify an audio file containing a prompt to be played as a welcome for callers to an automated attendant (AA) that is part of a Cisco Unified CME B-ACD service, use the param welcome-prompt command in application-parameter configuration mode. To return to the default, use the no form of this command.
param welcome-prompt audio-filename
no param welcome-prompt audio-filename
Syntax Description
Command Default
The audio file named en_bacd_welcome.au is used as a welcome prompt.
Command Modes
Application-parameter configuration (config-app-param)
Command History
12.3(14)T
Cisco CME 3.3
This command was introduced to replace the call application voice voice-mail command.
Usage Guidelines
This command is used with the Cisco Unified CME Basic Automatic Call Distribution and Auto-Attendant (B-ACD) service. This command is configured under the service command for an AA service.
Each AA service that is used with the Cisco Unified CME B-ACD service needs a welcome greeting to tell callers the destination they have reached and, sometimes, the options that they have. The en_bacd_welcome. au audio file is used by default. It announces "Thank you for calling," and includes a two-second pause after the message. The filename of the welcome prompt audio file has two parts: a two-letter prefix that denotes a language code specified in the paramspace language command, and the identifying part that indicates the purpose of the file. In the default welcome prompt audio file, the prefix is en and the identifying part is _bacd_welcome.au. Note that the identifying part starts with an underscore.
If your Cisco Unified CME B-ACD service uses a single AA application, you can record a custom welcome greeting in the audio file named en_welcome_prompt.au and record instructions about menu choices in the audio file named en_bacd_options_menu.au.
If your Cisco Unified CME B-ACD service uses multiple AA applications, you will need separate greetings and menu options for each AA. Use the following guidelines:
•
•
For any Cisco Unified CME B-ACD configuration changes to take effect, you must reload the scripts.
For more information, see the Cisco Unified CallManager Express B-ACD and Tcl Call-Handling Applications document for your release.
Examples
The following example sets parameters for two AA applications, called aa1 and aa2, and a call-queue application called queue. The direct-dial numbers to reach the AA services are (800) 555-0100 for aa1 and (800) 555-0110 for aa2. Callers to aa1 can press 1 to be connected to the ephone hunt group with the pilot number 5071 or can press 2 to dial an extension number of 4 or fewer digits. Callers to aa2 can press 2 to dial an extension number of 4 or fewer digits or press 3 to be connected to the ephone hunt group with the pilot number 5073. Both AAs share an operator hunt group, which is menu option 4.
The welcome prompt for aa1 is "Thank you for calling the Sales department. Press 1 to place an order. Press 2 if you know the extension of the party you want, or press 0 to speak to an operator." The filename of the audio file that contains this welcome prompt is en_aa1_welcome.au.
The welcome prompt for aa2 is "Thank you for calling the Service department. Press 2 if you know the extension of the party you want. Press 3 to speak to a service technician or press 0 to speak to an operator." The filename of the audio file that contains this welcome prompt is en_aa2_welcome.au.
dial-peer voice 1000 pots
service aa1
port 1/1/0
incoming called-number 8005550100
dial-peer voice 1100 pots
service aa2
port 1/1/1
incoming called-number 8005550110
ephone-hunt 10 sequential
pilot 5071
list 5011, 5012, 5013, 5014, 5015
ephone-hunt 11 sequential
pilot 5073
list 5021, 5022, 5023, 5024, 5025
!
application
service callq tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd.tcl
param queue-manager-debugs 1
param aa-hunt1 5071
param aa-hunt3 5073
param aa-hunt4 6000
param number-of-hunt-grps 3
param queue-len 10
!
service aa1 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550100
param welcome-prompt _aa1_welcome.au
param number-of-hunt-groups 2
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa1
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
service aa2 tftp://192.168.254.254/user1/CallQ/B-ACD/app-b-acd-aa.tcl
paramspace english location tftp://192.168.254.254/user1/prompts/
paramspace english index 0
paramspace english language en
param aa-pilot 8005550110
param welcome-prompt _aa2_welcome.au
param number-of-hunt-groups 2
param dial-by-extension-option 2
param max-extension-length 4
param service-name callq
param handoff-string aa2
param second-greeting-time 60
param call-retry-timer 15
param max-time-call-retry 700
param voice-mail 5000
param max-time-vm-retry 2
Related Commands
paramspace callsetup after-hours-exempt
To specify that an individual dial peer does not have any of its calls blocked by the Cisco router even though call blocking has been enabled, use the paramspace callsetup after-hours-exempt command in dial-peer configuration mode. To return to the default, use the no form of this command.
paramspace callsetup after-hours-exempt {true | false}
no paramspace callsetup after-hours-exempt
Syntax Description
true
Dial peer is exempt from call-blocking configuration.
false
Dial peer is subject to call-blocking configuration. This is default.
Command Default
All dial peers are subject to call-blocking configuration.
Command Modes
Dial-peer configuration (config-dial-peer)
Command History
12.4(4)T
Cisco CME 3.4
Cisco SRST 3.4This command was introduced.
Usage Guidelines
This command is intended to allow H.323 and SIP trunk calls to utilize the voice gateway in spite of the the after-hours configuration in Cisco Unified CME or Cisco Unified SRST.
A Cisco voice gateway (session application) accesses the after-hours call-blocking configuration set by Cisco Unified CME or Cisco Unified SRST and blocks all SCCP, SIP, H.323, and POTS calls that go through the Cisco router regardless of whether the call is from a phone controlled by the Cisco router or from a phone controlled by some other call control application, such as Cisco Unified CallManager.
To disable the After Hours Call Blocking feature for incoming calls from phones other than those registered to a Cisco Unified CME or Cisco Unified SRST router, use this command to exempt an individual H.323, SIP, or POTS dial peer from the call blocking configuration.
To disable the After Hours Call Blocking feature for an individual IP phone registered in Cisco Unified CME or Cisco Unified SRST:
•
•
•
•
Examples
The following example shows how to set the After Hours Call Blocking feature in Cisco Unified CME, and how to configure a particular dial peer (255) so that outgoing calls through this dial peer are exempt from this after-hours call blocking configuration:
Router(config)# telephony-service
Router(config-telephony)# after-hours block pattern 1 9011
Router(config-telephony)# exit
Router(config)# dial-peer voice 255 voip
Router(config-dial-peer)# paramspace callsetup after-hours-exempt true
Related Commands
park reservation-group
To assign a call-park reservation group to a phone, use the reservation-group command in ephone, ephone-template, voice register pool, or voice register template configuration mode. To remove the group from the phone, use the no form of this command.
park reservation-group group-number
no park reservation-group
Syntax Description
group-number
Unique number that identifies the reservation group. String can contain up to 32 digits.
Command Default
Extension does not belong to any reservation group.
Command Modes
Ephone configuration (config-ephone)
Ephone-template configuration (config-ephone-template)
Voice register pool configuration (config-register-pool)
Voice register template configuration (config-register-temp)Command History
Usage Guidelines
This command allows you to assign ownership to call-park slots by using Park Reservation Groups. A phone configured with a park reservation group can retrieve calls only from park slots configured with the same park reservation group. A phone without a park reservation group can retrieve calls from any park slot without an assigned park reservation group.
To assign a reservation group to a park-slot extension, use the park-slot reservation-group command.
If you use a template to apply a command to a phone and you also use the same command in ephone or voice register pool configuration mode for the same phone, the value that you set in the phone configuration mode has priority.
Examples
The following example shows park reservation-group 1 is assigned to phone 3 (SCCP). When calls for the Pharmacy are parked at extension 8126, phone 3 can retrieve them:
ephone-dn 26
number 8126
park-slot reservation-group 1 timeout 15 limit 2 transfer 8100
description park slot for Pharmacy
!
!
ephone 3
park reservation-group 1
mac-address 002D.264E.54FA
type 7962
button 1:3
The following example shows park reservation-group 1 is assigned to phone 120 (SIP). When calls for the Pharmacy are parked at extension 8126, phone 120 can retrieve them:
voice register pool 120
park reservation-group 1
id mac 0030.94C2.A22A
type 7962
number 1 dn 20
Related Commands
call-park system
Defines system parameters for the call-park feature.
park-slot
Creates an extension (call-park slot) at which calls can be temporarily held (parked).
park-slot
To create an extension (call-park slot) at which calls can be temporarily held (parked), use the park-slot command in ephone-dn configuration mode. To disable the extension, use the no form of this command.
park-slot [directed] [reservation-group group-number] [reserved-for extension-number] [[timeout seconds limit count] [notify extension-number [only]] [recall] [transfer extension-number] [alternate extension-number] [retry seconds limit count]]
no park-slot [directed] [reservation-group group-number] [reserved-for extension-number] [[timeout seconds limit count] [notify extension-number [only]] [recall] [transfer extension-number] [alternate extension-number] [retry seconds limit count]]
Syntax Description
Command Default
No call-park slot is defined.
Command Modes
Ephone-dn configuration (config-ephone-dn)
Command History
Usage Guidelines
This command creates a call-park slot that is a floating extension, or ephone-dn that is not bound to a physical phone, at which phone users can place calls on hold for later retrieval from the same phone or from another phone.
At least one call-park slot must be defined with this command before the Park soft key displays on IP phones in a Cisco Unified CME system.
Phone users park calls using the Park soft key. A phone user can then retrieve a call by dialing the extension number of the call-park slot. On SCCP phones, the phone user who parks the call can also retrieve the call by using the PickUp soft key and an asterisk (*). Other SCCP phone users can retrieve the call by using the PickUp soft key and dialing the extension number of the call-park slot.
Calls can also be transferred to a call-park slot using the Transfer key; a transfer to a call-park slot is always a blind transfer. Calls can also be forwarded to a call-park slot, and callers can directly dial call-park slots.
When a call that uses a G.711 codec is parked, the caller hears the music-on-hold (MOH) audio stream; otherwise, the caller hears the on-hold tone.
The directed keyword enables the extension as a park slot for Directed Call Park. To retrieve a call from a directed call-park slot, you must define the retrieval prefix with the fac command. The retrieval prefix is supported for both SCCP and SIP phones.
The reservation-group keyword allows you to assign ownership to call-park slots by using Park Reservation Groups. A park slot configured with a park reservation group can only be used by phones configured with the same park reservation group. A park slot without a park reservation group can be used by any phone not assigned to a park reservation group.
A reminder ring can be sent to the extension that parked the call by using the timeout keyword, which sets the interval length to wait before sending call-park reminder rings. The number of time-out intervals and reminder rings are configured with the limit keyword and argument. For example, a limit of 3 timeout intervals sends 2 reminder rings (interval 1, ring 1, interval 2, ring 2, interval 3). The timeout and limit keywords and arguments also set the maximum time that calls stay parked. For example, a timeout interval of 10 seconds and a limit of 5 timeout intervals (park-slot timeout 10 limit 5) will park calls for approximately 50 seconds.
If the timeout keyword is not used with this command, no reminder ring is sent to the extension that parked the call. If the timeout keyword is used, a reminder ring is sent only to the extension that parked the call unless the notify keyword is also used to specify an additional extension number to receive a reminder ring. When an additional extension number is specified using the notify keyword, the phone user at that extension can retrieve a call from this slot by pressing the PickUp soft key and an asterisk (*).
Each call-park slot can hold one call at a time, so the number of simultaneous calls that can be parked is equal to the number of slots that have been created. The reserved-for keyword creates a call-park slot that is dedicated for use by one extension so that extension always has a slot available at which to park a call. With nonreserved slots, multiple call-park slots can be created with the same extension number so that all the calls that are parked for a particular group can be parked at a known extension number. For example, at a hardware store, calls for the plumbing department can be parked at extension 101, calls for lighting can be parked at 102, and so forth. Then, anyone in the plumbing department can pick up calls from extension 101. When multiple calls are parked at the same extension number, they are picked up in the order in which they were parked; that is, the call that has been parked the longest is the first call picked up from that extension number.
IP phone users park calls at their dedicated call-park slots using the Park soft key. Phone users can also transfer calls to dedicated call-park slots using the Transfer soft key and a standard or custom feature access code (FAC) for call park. On analog phones, users transfer calls to dedicated call-park slots using hookflash and a standard or custom FAC for call park. The standard FAC for call park is **6. Custom FACs are created using the fac command.
If a dedicated park slot is not found for an ephone-dn attempting to park a call, Cisco Unified CME uses the standard call-park procedure; that is, the system searches for a preferred park slot (one with an ephone-dn number that matches the last two digits of the ephone-dn attempting to park the call) and if none is found, uses any available call-park slot.
If a name has been specified for a call-park slot, that name is displayed instead of an extension number on a recall or transfer of the call.
A parked call can have the following dispositions after its timeouts expire:
•
•
•
•
Examples
Basic Call Park
The following example shows a basic call-park slot at extension 1001. After a call is parked at this number, the system provides 10 reminder rings at intervals of 30 seconds to the extension that parked the call. Any phone can retrieve calls parked at this extension.
ephone-dn 45
number 1001
park-slot timeout 30 limit 10
Directed Call Park (Cisco Unified CME 4.4 and Later Versions)
The following example shows two call-park slots, extension 3110 and 3111, that can be used to park calls for the pharmacy using Directed Call Park.
ephone-dn 10
number 3110
park-slot directed
description park-slot for Pharmacy
!
ephone-dn 11
number 3111
park-slot directed
description park-slot for Pharmacy
Park Reservation Groups (Cisco Unified CME 4.4 and Later Versions)
The following example shows park reservation groups set up for two call-park slots. Extension 8126 is configured for group 1 and assigned to phones 3 and 4. Extension 8127 is configured for group 2 and assigned to phones 10 and 11. When calls for the Pharmacy are parked at extension 8126, only phones 3 and 4 can retrieve them.
ephone-dn 26
number 8126
park-slot reservation-group 1 timeout 15 limit 2 transfer 8100
description park slot for Pharmacy
!
ephone-dn 27
number 8127
park-slot reservation-group 2 timeout 15 limit 2 transfer 8100
description park slot for Auto
!
!
ephone 3
park reservation-group 1
mac-address 002D.264E.54FA
type 7962
button 1:3
!
ephone 4
park reservation-group 1
mac-address 0030.94C3.053E
type 7962
button 1:4
!
ephone 10
park reservation-group 2
mac-address 00E1.CB13.0395
type 7960
button 1:10
!
ephone 11
park reservation-group 2
mac-address 0016.9DEF.1A70
type 7960
button 1:11
Dedicated Park
The following example shows a dedicated call-park slot, 2558, that is reserved for the phone that has the primary extension of 2977. Both extension 2977 and 2976 are on the same phone, so they both can use this slot, which is reserved only for the extensions on that phone. After three timeout intervals of 60 seconds, a parked call is recalled to extension 2977. If extension 2977 is busy, the call is rerouted to extension 3754.
ephone-dn 24
number 2977
ephone-dn 25
number 2976
ephone-dn 27
number 3754
ephone-dn 30
number 2558
name Park 2977
park-slot reserved-for 2977 timeout 60 limit 3 recall alternate 3754
ephone 44
button 1:24 2:25
ephone 45
button 1:27
Related Commands
pattern (voice register dialplan)
To define a dial pattern for a SIP dial plan, use the pattern command in voice register dialplan configuration mode. To remove the pattern, use the no form of this command.
pattern tag string [button button-number] [timeout seconds] [user {ip | phone}]
no pattern tag
Syntax Description
Command Default
No pattern is defined.
Command Modes
Voice register dialplan configuration (config-register-dialplan)
Command History
Usage Guidelines
This command defines a pattern of dialed digits that are matched by the phone and passed to Cisco Unified CME to initiate a call. Dial strings that match the pattern trigger the sending of a SIP INVITE message to Cisco Unified CME. Patterns are matched sequentially in order of the tag number.
You must first use the type command to specify the type of phone that the dial plan is being defined for before you can enter a pattern. Enter this command for each dial pattern that is part of the dial plan definition. After you define a dial plan, assign it to a SIP phone by using the dialplan command.
The button keyword specifies the button to which the dial pattern applies. If the user is initiating a call on line button 1, only the dial patterns specified for button 1 apply. If this keyword is not configured, the dial pattern applies to all lines on the phone. This keyword is not supported on Cisco Unified IP Phones 7905 or 7912. The button number corresponds to the order of the buttons on the side of the screen, from top to bottom, with 1 being the top button.
The pattern command and filename command are mutually exclusive. You can use either the pattern command to define dial patterns manually for a dial plan, or the filename command to select a custom dial pattern file that is loaded in system flash.
Examples
The following example shows the dial patterns set for SIP dial plan 10:
Router(config)# voice register dialplan 10
Router(config-register-dialplan)# type 7905-7912
Router(config-register-dialplan)# pattern 52...
Router(config-register-dialplan)# pattern 91.......
Related Commands
pattern direct
To configure the dual tone multifrequency (DTMF) digit pattern forwarding necessary to activate the voice-mail system when a user presses the Messages button on an IP phone in a Cisco CallManager Express (Cisco CME) system, use the pattern direct command in voice-mail integration configuration mode. To disable DTMF pattern forwarding when a user presses the Messages button on a phone, use the no form of this command.
pattern direct tag1 {CDN | CGN | FDN} [tag2 {CDN | CGN | FDN}]
[tag3 {CDN | CGN | FDN}] [last-tag]no pattern direct
Syntax Description
Command Default
This feature is disabled.
Command Modes
Voice-mail integration configuration (config-vm-integration)
Command History
12.2(2)XT
2.0
This command was introduced
12.2(8)T
2.0
This command was integrated into Cisco IOS Release 12.2(8)T.
Usage Guidelines
The pattern direct command is used to configure the sequence of dual tone multifrequency (DTMF) digits passed to a voice-mail system attached to the router through one or more voice ports. When a call is placed directly from a Cisco IP phone attached to the router, the voice-mail system expects to receive a sequence of DTMF digits at the beginning of the call to identify the user's mailbox, accompanied by a string of digits to indicate that the caller is attempting to access the designated mailbox in order to retrieve messages.
Although it is unlikely that you will use multiple instances of the CDN, CGN, or FDN keywords in a single command line, it is permissible to do so.
Examples
The following example sets the DTMF pattern for a calling number (CGN) for a direct call to the voice-mail system:
Router(config) vm-integration
Router(config-vm-integration) pattern direct 2 CGN *
Related Commands
pattern ext-to-ext busy
To configure the dual tone multifrequency (DTMF) digit pattern forwarding necessary to activate a voice-mail system after an internal extension attempts to connect to a busy extension and the call is forwarded to voice mail, use the pattern ext-to-ext busy command in voice-mail integration configuration mode. To disable the feature, use the no form of this command.
pattern ext-to-ext busy tag1 {CDN | CGN | FDN} [tag2 {CDN | CGN | FDN}]
[tag3 {CDN | CGN | FDN}] [last-tag]no pattern ext-to-ext busy
Syntax Description
Command Default
This feature is disabled.
Command Modes
Voice-mail integration configuration (config-vm-integration)
Command History
Usage Guidelines
The pattern ext-to-ext busy command is used to configure the sequence of DTMF digits passed to a voice-mail system attached to the router through one or more voice ports. When a call is routed to the voice-mail system by call forward on busy from a Cisco IP phone attached to the router, the voice-mail system expects to receive digits that identify the mailbox associated with the forwarding phone together with digits that identify the extension number of the calling IP phone.
Although it is unlikely that you will use multiple instances of the CDN, CGN, or FDN keywords in a single command line, it is permissible to do so.
Examples
The following example sets the DTMF pattern for a local call forwarded on busy to the voice-mail system:
Router(config) vm-integration
Router(config-vm-integration) pattern ext-to-ext busy 7 FDN * CGN *
Related Commands
pattern ext-to-ext no-answer
To configure the dual tone multifrequency (DTMF) pattern forwarding necessary to activate the voice-mail system once an internal extension fails to connect to a non answering extension and the call is forwarded to voice mail, use the pattern ext-to-ext no-answer command in voice-mail integration configuration mode. To disable this feature, use the no form of this command.
pattern ext-to-ext no-answer tag1 {CDN | CGN | FDN} [tag2 {CDN | CGN | FDN}]
[tag3 {CDN | CGN | FDN}] [last-tag]no pattern ext-to-ext no-answer
Syntax Description
Defaults
This feature is disabled.
Command Modes
Voice-mail integration configuration (config-vm-integration)
Command History
Usage Guidelines
The pattern ext-to-ext no-answer command is used to configure the sequence of DTMF digits passed to a voice-mail system attached to the router through one or more voice ports. When a call is routed to the voice-mail system by call forward on no-answer from an IP phone attached to the router, the voice-mail system expects to receive digits that identify the mailbox associated with the forwarding phone together with digits that identify the extension number of the calling IP phone.
Although it is unlikely that you will use multiple instances of the CDN, CGN, or FDN keywords in a single command line, it is permissible to do so.
Examples
The following example sets the DTMF pattern for a local call forwarded on no-answer to the voice-mail system:
Router(config) vm-integration
Router(config-vm-integration) pattern ext-to-ext no-answer 5 FDN * CGN *
Related Commands
pattern trunk-to-ext busy
To configure the dual tone multifrequency (DTMF) digit pattern forwarding necessary to activate the voice-mail system once an external trunk call reaches a busy extension and the call is forwarded to voice mail, use the pattern trunk-to-ext busy command in voice-mail integration configuration mode. To return to the default, use the no form of this command.
pattern trunk-to-ext busy tag1 {CDN | CGN | FDN} [tag2 {CDN | CGN | FDN}]
[tag3 {CDN | CGN | FDN}] [last-tag]no pattern trunk-to-ext busy
Syntax Description
Command Default
This feature is disabled by default.
Command Modes
Voice-mail integration configuration (config-vm-integration)
Command History
Usage Guidelines
The pattern trunk-to-ext busy command is used to configure the sequence of DTMF digits passed to a voice-mail system attached to the router through one or more voice ports. When a call is routed to the voice-mail system by call forward on busy from an IP phone attached to the router, the voice-mail system expects to receive a sequence of digits identifying the mailbox associated with the forwarding phone together with digits indicating that the call originated from a PSTN or VoIP caller.
Although it is unlikely that you will use multiple instances of the CDN, CGN, or FDN keywords in a single command line, it is permissible to do so.
Examples
The following example sets the DTMF pattern for call forwarding when an external trunk call reaches a busy extension and the call is forwarded to the voice-mail system:
Router(config) vm-integration
Router(config-vm-integration) pattern trunk-to-ext busy 6 FDN * CGN *
Related Commands
pattern trunk-to-ext no-answer
To configure the dual tone multifrequency (DTMF) digit pattern forwarding necessary to activate the voice-mail system when an external trunk call reaches an unanswered extension and the call is forwarded to voice mail, use the pattern trunk-to-ext no-answer command in voice-mail integration configuration mode. To disable this feature, use the no form of this command.
pattern trunk-to-ext no-answer tag1 {CDN | CGN | FDN} [tag2 {CDN | CGN | FDN}]
[tag3 {CDN | CGN | FDN}] [last-tag]no pattern trunk-to-ext no-answer
Syntax Description
Command Default
This feature is disabled.
Command Modes
Voice-mail integration configuration (config-vm-integration)
Command History
Usage Guidelines
The pattern trunk-to-ext no-answer command is used to configure the sequence of DTMF digits passed to a voice-mail system attached to the router through one or more voice ports. When a call is routed to the voice-mail system by call forward on no-answer from an IP phone attached to the router, the voice-mail system expects to receive digits that identify the mailbox associated with the forwarding phone together with digits that indicate that the call originated from a PSTN or VoIP caller.
Although it is unlikely that you will use multiple instances of the CDN, CGN, or FDN keywords in a single command line, it is permissible to do so.
Examples
The following example sets the DTMF pattern for call forwarding when an external trunk call reaches an unanswered extension and the call is forwarded to a voice-mail system:
Router(config) vm-integration
Router(config-vm-integration) pattern trunk-to-ext no-answer 4 FDN * CGN *
Related Commands
phone-key-size
To specify the size of the RSA key pair that is generated on phones, use the phone-key-size command in CAPF-server configuration mode. To return the size to the default, use the no form of this command.
phone-key-size {512 | 1024 | 2048}
no phone-key-size
Syntax Description
Command Default
RSA key pair size is 1024.
Command Modes
CAPF-server configuration (config-capf-server)
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.
If you choose a higher key size than the default setting, the phones take longer to generate the entropy that is required to generate the keys. Key generation, which is set at low priority, allows the phone to function while the action occurs. Depending on the phone model, you may notice that key generation takes up to 30 or more minutes to complete.
Examples
The following example specifies a key size of 2048 bits.
Router(config)# capf-server
Router(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
phoneload
To define the phone firmware support for a phone type, use the phoneload command in ephone-type configuration mode. To remove firmware support, use the no form of this command.
phoneload
no phoneload
Syntax Description
This command has no arguments or keywords.
Command Default
Phone type supports firmware configuration.
Command Modes
Ephone-type configuration (config-ephone-type)
Command History
Usage Guidelines
This command specifies whether the phone type defined in the phone-type template supports firmware configuration using the load command.
Examples
The following example shows that support for phone firmware is disabled for the Nokia E61 phone type:
Router(config)# ephone-type E61
Router(config-ephone-type)# no phoneload
Related Commands
device-name
Assigns a name to a phone type in an ephone-type template.
load
Associates a type of Cisco Unified IP phone with a phone firmware file.
phone-redirect-limit (voice register global)
To set the number of 3XX responses an originating SIP phone in a Cisco CallManager Express (Cisco CME) system can accept for a single call, use the phone-redirect-limit command in voice register global configuration mode. To revert to the default, use the no form of this command.
phone-redirect-limit number
no phone-redirect-limit
Syntax Description
Command Default
Default is 5
Command Modes
Voice register global configuration (config-register-global)
Command History
Usage Guidelines
Use this command to control how many subsequent 3XX responses an originating SIP phone can handle for a single call. The terminating side is any forwarding party which does not use B2BUA, but sends 3XX directly to the originating calling phone. When Cisco CME gets a 3XX from the terminating side, Cisco CME relays the 3XX to the originating SIP phone. The default number of 3XXs that the originating phone can accept is 5.
The following example shows how to set the maximum number of redirects to 6:
Router(config)# voice register global
Router(config-register-global)# phone-redirect-limit 6
Related Commands
voice register global
Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.
phone-ui speeddial-fastdial
To enable a phone user to configure speed-dial and fast-dial numbers from their phone, use the phone-ui speeddial-fastdial command in ephone configuration mode. To reset to the default value, use the no form of this command.
phone-ui speeddial-fastdial
no phone-ui speeddial-fastdial
Syntax Description
This command has no arguments or keywords.
Command Default
Enabled (speed-dial and fast-dial numbers are configurable from phone).
Command Modes
Ephone configuration (config-ephone)
Command History
Usage Guidelines
This command enables the speed-dial and fast-dial configuration menu on the phone so that users can configure these options directly.
The services URL must be configured using the url services command.
Examples
The following example shows that the speed-dial and fast-dial user interface is disabled for phone 7:
Router(config)# ephone 7
Router(config-ephone-type)# no phone-ui speeddial-fastdial
Related Commands
pickup-call any-group
To enable a phone user to pickup a ringing call on extensions in any pickup group, use the pickup-call any-group command in ephone-dn or voice register dn configuration mode. To reset to the default value, use the no form of this command.
pickup-call any-group
no pickup-call any-group
Syntax Description
This command has no arguments or keywords.
Command Default
User can pickup calls in other groups by pressing GPickUp soft key and dialing pickup group number.
Command Modes
Ephone-dn configuration (config-ephone-dn)
Voice register dn configuration (config-register-dn)Command History
Usage Guidelines
This command allows a phone user to pickup any ringing call within the local Cisco Unified CME system by pressing the GPickUp soft key and asterisk (*), if the ringing extension is configured with a pickup group using the pickup-group command.
If this command is not configured, a phone user can pickup calls only from their local group by pressing the GPickUp soft key and *. To pickup calls in another group, the user must press the GPickUp soft key and dial the pickup group number.
Examples
The following example shows that extension 1020 can pick up calls ringing on extension 1030 by pressing the GPickUp softkey and *:
ephone-dn 102
number 1020
pickup-call any-group
!
ephone-dn 103
number 1030
pickup-group 5
Related Commands!
pickup-group
To assign an extension to a call-pickup group, use the pickup-group command in ephone-dn, ephone-dn-template, or voice register dn configuration mode. To remove the extension from a group, use the no form of this command.
pickup-group group-number
no pickup-group
Syntax Description
Command Default
An extension does not belong to any pickup group.
Command Modes
Ephone-dn configuration (config-ephone-dn)
Ephone-dn-template configuration (config-ephone-dn-template)
Voice register dn configuration (config-register-dn)Command History
Usage Guidelines
This command allows you to assign an individual directory number to a call-pickup group. Phone users can pick up ringing calls within their own pickup group more easily than calls outside their group.
You can assign each directory number to only one pickup group. There is no limit to the number of directory numbers that can be assigned to a single pickup group, and there is no limit to the number of pickup groups that can be defined in a Cisco Unified CME system.
Pickup group numbers can vary in length, but must have unique leading digits. For example, you cannot define pickup group 17 and pickup group 177 in the same Cisco Unified CME system because a pickup in group 17 will always be triggered before the user can enter the final 7 for group 177. You can, however, define pickup groups 27 and 177 in the same Cisco Unified CME system.
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 examples assign extension 3242 to pickup group 25:
Router(config)# ephone-dn 4
Router(config-ephone-dn)# number 3242
Router(config-ephone-dn)# pickup-group 25
Router(config)# voice register dn 4
Router(config-register-dn)# number 3242
Router(config-register-dn)# pickup-group 25
The following example uses an ephone-dn-template to assign extension 3242 to pickup group 25:
Router(config)# ephone-dn-template 8
Router(config-ephone-dn-template)# pickup-group 25
Router(config-ephone-dn-template)# exit
Router(config)# ephone-dn 4
Router(config-ephone-dn)# number 3242
Router(config-ephone-dn)# ephone-dn-template 8
Related Commands
pilot
To define the ephone-dn that callers dial to reach a Cisco CallManager Express (Cisco CME) ephone hunt group, use the pilot command in ephone-hunt configuration mode. To remove the pilot number from the ephone hunt group, use the no form of this command.
pilot number [secondary number]
no pilot number [secondary number]
Syntax Description
Command Default
No pilot number is defined.
Command Modes
Ephone-hunt configuration (config-ephone-hunt)
Command History
Usage Guidelines
This command defines a valid number for an ephone-dn (extension) that is to be assigned to an ephone hunt pilot group. The dial-plan pattern can be applied to the pilot number.
The secondary keyword allows you to associate a second telephone number with this ephone-dn so that the hunt group can be called by dialing either the main or secondary phone number. The secondary number may contain one or more wildcards instead of digits, even if the wildcard number overlaps the primary number. For example, 50.. (the number 50 followed by periods, which stand for wildcards) matches all four-digit extensions that start with 50. Wildcard characters cannot be used in the primary pilot number.
Alphabetic characters can be used to create a primary or secondary pilot number that cannot be dialed from a phone and is not part of the dial plan.
Examples
The following example sets the pilot number to 2345 for peer ephone hunt group number 5:
ephone-hunt 5 peer
pilot 2345
list 2346, 2347, 2348
hops 3
timeout 45
final 6000
The following example sets the pilot number for ephone hunt group 3 to 2222 and the secondary pilot number to 4444:
ephone-hunt 3 sequential
pilot 2222 secondary 4444
list 2555, 2556, 2557
final 6000
The following example uses wildcards in the secondary pilot number to create a hunt group that receives the calls made to all numbers that start with 555. The primary pilot number, A0, cannot be dialed.
ephone-hunt 1 longest-idle
pilot A0 secondary 555....
list 1000, 1001, 1002
timeout 5
hops 3
final 1100
Related Commands
pilot (voice hunt-group)
To define the number that callers dial to reach a Cisco Unified CME voice hunt group, use the pilot command in voice hunt-group configuration mode. To remove the pilot number from the voice hunt group, use the no form of this command.
pilot number [secondary number]
no pilot
Syntax Description
number
String of up to 32 characters that represents an extension or E.164 telephone number.
secondary
(Optional) Defines an additional pilot number for the voice hunt group.
Command Default
No pilot number is defined.
Command Modes
Voice hunt-group configuration (config-voice-hunt-group)
Command History
Usage Guidelines
This command defines an extension that is assigned as the pilot number of a voice hunt group. The dial-plan pattern can be applied to the pilot number.
Normally the pilot number is composed of digits, but the string may contain alphabetic characters if the number is dialed only by the router, as with an intercom number, or is not intended to be dialed at all.
The secondary keyword allows you to associate a second telephone number so that the hunt group can be called by dialing either the primary or secondary phone number. The secondary number can contain one or more wild cards instead of digits, even if the wildcard number overlaps the primary number. For example, 50.. (the number 50 followed by periods, which stand for wild card) matches all four-digit extensions that start with 50. Wildcard characters cannot be used in the primary pilot number.
Alphabetic characters can be used to create a primary or secondary pilot number that cannot be dialed from a phone and is not part of the dial plan.
Voice hunt groups do not support the expansion of pilot numbers using the dialplan-pattern command. To enable external phones to dial the pilot number, you must configure a secondary pilot number using a fully qualified E.164 number.
Examples
The following example shows how to set the pilot number to 2345 for voice hunt group hunt group number 5:
voice-hunt 5 peer
pilot 2345
list 2346, 2347, 2348
hops 3
timeout 45
final 6000
The following example shows how to set the pilot number for voice hunt group 3 to 2222 and the secondary pilot number to 4444:
voice hunt-group 3 sequential
pilot 2222 secondary 4444
final 6000
The following example shows how to use wild cards in the secondary pilot number to create a voice hunt group that receives the calls made to all numbers that start with 55501. The primary pilot number, A0, cannot be dialed.
voice hunt-group 1 longest-idle
pilot A0 secondary 55501..
list 1000, 1001, 1002
timeout 5
hops 3
final 1100
The following example shows how to use a secondary pilot number in a parallel hunt group. Local phones can dial the primary pilot number, 1100. External phones (PSTN) must dial the full E.164 number, 4085550100.
voice hunt-group 4 parallel
final 1109
list 1101,1102,1103,1104
timeout 60
pilot 1100 4085550100
Related Commands
pin
To set a personal identification number (PIN) for an IP phone in a Cisco CallManager Express (Cisco CME) system, use the pin command in ephone configuration mode. To remove a PIN, use the no form of this command.
pin number
no pin
Syntax Description
number
PIN that will be used to log in to a Cisco IP phone. This is a numeric string from four to eight digits in length.
Defaults
No PIN is set.
Command Modes
Ephone configuration (config-ephone)
Command History
12.2(15)ZJ
Cisco CME 3.0
This command was introduced.
12.3(4)T
Cisco CME 3.0
This command was integrated into Cisco IOS Release 12.3(4)T.
Usage Guidelines
The pin command allows individual phone users to override call-blocking patterns that are associated with defined time periods. Call-blocking patterns that are in effect at all times (7 days a week, 24 hours a day) cannot be overridden using a PIN.
Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits to be blocked are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in a Cisco CME system are restricted if at least one pattern and at least one time period are defined. Individual phones can be completely exempted from call blocking using the after-hour exempt command. An individual with a PIN can override call blocking by entering the PIN after pressing the Login soft key to log in to a phone that has been configured for that PIN using the pin command.
The PIN functionality applies only to IP phones that have soft keys, such as the Cisco IP Phones 7940 and 7940G and the Cisco IP Phones 7960 and 7960G.
Examples
The following example sets a PIN for an IP phone:
Router(config)# ephone 1
Router(config-ephone)# pin 1000
Related Commands
pin (voice logout-profile and voice user-profile)
To configure a personal identification number (PIN) for accessing a particular IP phone that is enabled for extension mobility, use the pin command in voice logout-profile configuration mode or voice user-profile configuration mode. To remove a PIN, use the no form of this command.
pin number
no pin number
Syntax Description
Command Default
No PIN is configured.
Command Modes
Voice logout-profile configuration (config-logout-profile)
Voice user-profile configuration (config-user-profile)Command History
Usage Guidelines
Use this command in voice logout-profile configuration mode to create a PIN to be used by a phone user to disable the call blocking configuration for a Cisco Unified IP phone on which a logout profile is downloaded.
Use this command in voice user-profile configuration mode to create a PIN to be used by a phone user to disable the call blocking configuration for a Cisco Unified IP phone on which a user profile is downloaded.
PIN functionality applies only to IP phones that have soft keys, such as the Cisco Unified IP Phone 7940 and 7940G.
Examples
The following example shows the configuration for a user profile to be downloaded when a phone user logs into a Cisco Unified IP phone that is enabled for extension mobility, including a PIN of 12345:
pin 12345
user me password pass123
number 2001 type silent-ring
number 2002 type beep-ring
number 2003 type feature-ring
number 2004 type monitor-ring
number 2005,2006 type overlay
number 2007,2008 type cw-overly
speed-dial 1 3001
speed-dial 2 3002 blf
Related Commands
port (CAPF-server)
To define the TCP port number on which the CAPF server listens for incoming socket connections, use the port command in CAPF-server configuration mode. To use the default, use the no form of this command.
port tcp-port
no port
Syntax Description
Command Default
TCP port number 3804.
Command Modes
CAPF-server configuration (config-capf-server)
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 specifies TCP port 3000 instead of the default port 3804:
Router(config)# capf-server
Router(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
preemption reserve timer
To set the amount of time to reserve a channel for a preemption call, use the preemption reserve timer command in voice MLPP configuration mode. To reset to the default, use the no form of this command.
preemption reserve timer seconds
no preemption reserve timer
Syntax Description
Command Default
Preemption reserve timer is disabled (0).
Command Modes
Voice MLPP configuration (config-voice-mlpp)
Command History
When a channel on a SCCP phone is preempted by a higher priority MLPP call, the channel is reserved for the MLPP call so that other calls cannot use that channel before the call is connected.
Examples
The following example shows the reserve timer set to 10 seconds.
Router(config)# voice mlppRouter(config-voice-mlpp)# preemption reserve timer 10Related Commands
preemption tone timer (voice MLPP)
To set the amount of time the preemption tone plays on the called phone when a lower precedence call is being preempted, use the preemption tone timer command in voice MLPP configuration mode. To reset to the default, use the no form of this command.
preemption tone timer seconds
no preemption tone timer
Syntax Description
Command Default
Preemption tone timer is disabled (0).
Command Modes
Voice MLPP configuration (config-voice-mlpp)
Command History
This command sets how long a phone user hears the preemption tone play when a lower precedence call is being preempted by a higher priority call. The preemption tone stops playing when the timer expires or the user goes onhook.
For calls to Cisco Unified IP phones, the called party can hang up immediately to connect to the new higher precedence call, or if the called party does not hang up, Cisco Unified CME forces the phone on-hook after the preemption tone timer expires and connects the call.
For FXS ports, t
