Table Of Contents
Cisco IOS Voice Commands:
C
cac master
cache (neighbor BE)
cadence
cadence-list
cadence-max-off-time
cadence-min-on-time
cadence-variation
call accounting-template voice
call accounting-template voice reload
call application alternate
call application cache reload time
call application voice
call application voice access-method
call application voice account-id-method
call application voice accounting enable
call application voice accounting-list
call application voice accounting-template
call application voice authen-list
call application voice authen-method
call application voice authentication enable
call application voice dsn-script
call application voice fax-dtmf
call application voice global-password
call application voice language
call application voice load
call application voice mail-script
call application voice mode
call application voice pin-len
call application voice prompt
call application voice redirect-number
call application voice retry-count
call application voice security trusted
call application voice set-location
call application voice transfer mode
call application voice transfer reroute-mode
call application voice uid-length
call application voice voice-dtmf
call application voice warning-time
call fallback
call fallback active
call fallback cache-size
call fallback cache-timeout
call fallback instantaneous-value-weight
call fallback jitter-probe dscp
call fallback jitter-probe num-packets
Cisco IOS Voice Commands:
C
This chapter contains commands to configure and maintain Cisco IOS voice applications. The commands are presented in alphabetical order. Some commands required for configuring voice may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.
For detailed information on how to configure these applications and features, refer to the Cisco IOS Voice Configuration Guide.
cac master
To configure the call admission control (CAC) operation as master, enter the cac master command in voice-service configuration mode. To restore CAC operation to slave, use the no form of this command.
cac master
no cac master
Syntax Description
This command has no arguments or keywords.
Defaults
CAC operation is slave
Command Modes
Voice-service configuration
Command History
Release
|
Modification
|
12.1(1)XA
|
This command was introduced on the Cisco MC3810.
|
12.1(2)T
|
This command was integrated into Cisco IOS Release 12.1(2)T.
|
12.2(2)T
|
This command was implemented on the Cisco 7200.
|
Usage Guidelines
You should configure the Cisco MC3810 multiservice access concentrator and Cisco 7200 series router at opposite ends of an ATM adaptation layer 2 (AAL2) trunk for the opposite CAC operation—master at one end and slave at the other end.
A Cisco MC3810 multiservice access concentrator or a Cisco 7200 series router configured as a master always performs CAC during fax and modem upspeed. A Cisco MC3810 multiservice access concentrator or a Cisco 7200 series router configured as a slave sends a request for CAC to the CAC master.
Examples
The following example shows configuration of the CAC operation of a Cisco MC3810 multiservice access concentrator and a Cisco 7200 series router as master:
The following example shows configuration of these entities being returned to slave status:
cache (neighbor BE)
To configure the local border element (BE) to cache the descriptors received from its neighbors, use the cache command in neighbor BE configuration mode. To disable caching, use the no form of this command.
cache
no cache
Syntax Description
This command has no arguments or keywords.
Defaults
Caching is not enabled
Command Modes
Neighbor BE configuration
Command History
Release
|
Modification
|
12.2(2)XA
|
This command was introduced.
|
12.2(4)T
|
This command was integrated into Cisco IOS Release 12.2(4)T. Support for the Cisco AS5300 universal access server, Cisco AS5350, Cisco AS5400 is not included in this release.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T.
|
Usage Guidelines
Use this command to configure the local BE to cache the descriptors received from its neighbor. If caching is enabled, the neighbors are queried at the specified interval for their descriptors.
Examples
The following example shows the border element enabled to cache the descriptors from its neighbors.
Router(config-annexg-neigh)# id neighbor-id
Router(config-annexg-neigh)# cache
Related Commands
Command
|
Description
|
id
|
Configures the local ID of the neighboring BE.
|
port
|
Configures the neighbor's port number that is used for exchanging Annex G messages.
|
query-interval
|
Configures the interval at which the local BE queries the neighboring BE.
|
cadence
To define the tone-on and tone-off durations for a call-progress tone, use the cadence command in cp-dualtone configuration mode. To restore the default cadence, use the no form of this command.
cadence {cycle-1-on-time cycle-1-off-time [cycle-2-on-time cycle-2-off-time] [cycle-3-on-time
cycle-3-off-time] [cycle-4-on-time cycle-4-off-time]} | continuous
no cadence
Syntax Description
cycle-1-on-time
|
Tone-on duration for the first cycle of the cadence pattern, in milliseconds (ms). Range is from 0 to 1000. The default is 0.
|
cycle-1-off-time
|
Tone-off duration for the first cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
cycle-2-on-time
|
(Optional) Tone-on duration for the second cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
cycle-2-off-time
|
(Optional) Tone-off duration for the second cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
cycle-3-on-time
|
(Optional) Tone-on duration for the third cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
cycle-3-off-time
|
(Optional) Tone-off duration for the third cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
cycle-4-on-time
|
(Optional) Tone-on duration for the fourth cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
cycle-4-off-time
|
(Optional) Tone-off duration for the fourth cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
|
continuous
|
Continuous call-progress tone is detected.
|
Defaults
Continuous
Command Modes
cp-dualtone configuration
Command History
Release
|
Modification
|
12.1(5)XM
|
This command was introduced on the Cisco 2600 series, Cisco 3600 series and the Cisco MC3810.
|
12.2(2)T
|
This command was implemented on the Cisco 1750 and integrated into Cisco IOS Release 12.2(2)T.
|
Usage Guidelines
This command specifies the cadence for a class of custom call-progress tones.
You must define each cadence that you want a voice port to detect. Reenter the command for each additional cadence to be detected.
You must associate the class of custom call-progress tones with a voice port for this command to affect tone detection.
Examples
The following example defines a cadence for a busy tone in the custom-cptone voice class with the name "country-x". This example defines 500 ms tone on and 500 ms tone off.
voice class custom-cptone country-x
The following example configures detection of the default frequency and cadence values for the busy tone in the custom-cptone voice class with the name "country-x". The default frequency is a 300 Hz tone, and the default cadence is continuous.
voice class custom-cptone country-x
Related Commands
Command
|
Description
|
supervisory custom-cptone
|
Associates a class of custom call-progress tones with a voice port.
|
voice class custom-cptone
|
Creates a voice class for defining custom call-progress tones.
|
voice class dualtone-detect-params
|
Modifies the boundaries and limits for custom call-progress tones defined by the voice class custom-cptone command.
|
cadence-list
To specify a tone cadence pattern to be detected, use the cadence-list command in voice-class configuration mode. To delete a cadence pattern, use the no form of this command.
cadence-list cadence-id cycle-1-on-time cycle-1-off-time [cycle-2-on-time cycle-2-off-time]
[cycle-3-on-time cycle-3-off-time] [cycle-4-on-time cycle-4-off-time]
no cadence-list cadence-id
Syntax Description
cadence-id
|
A tag to identify this cadence list. The range is from 1 to 10.
|
cycle-1-on-time
|
The tone duration for the first cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-1-off-time
|
The silence duration for the first cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-2-on-time
|
(Optional) The tone duration for the second cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-2-off-time
|
(Optional) The silence duration for the second cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-3-on-time
|
(Optional) The tone duration for the third cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-3-off-time
|
(Optional) The silence duration for the third cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-4-on-time
|
(Optional) The tone duration for the fourth cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
cycle-4-off-time
|
(Optional) The silence duration for the fourth cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
|
Defaults
No cadence pattern is configured
Command Modes
Voice-class configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced on the Cisco 2600 series, Cisco 3600 series, the Cisco MC3810.
|
Usage Guidelines
A cadence list enables the router to match a complex tone pattern from a PBX or public switched telephone network (PSTN). A tone is detected if it matches any configured cadence list. You can create up to ten cadence lists, enabling the router to detect up to ten different tone patterns. If the tone to be detected consists of only one on-off cycle, you can configure this in either of two ways:
•
Create a cadence list using only the cycle-1-on-time and cycle-1-off-time variables.
•Use the cadence-max-off-time and cadence-min-on-time commands.
You must also configure the times of the cadence-max-off-time and cadence-min-on-time commands to be compatible with the on and off times specified by the cadence-list command. The time of the cadence-max-off-time must be equal to or greater than the longest off-time in the cadence list; the cadence-min-on-time must be equal to or less than the shortest on-time in the cadence list.
Examples
The following example shows configuration of cadence list 1 with three on/off cycles and cadence list 2 with two on/off cycles for voice class 100:
cadence-list 1 100 100 300 300 100 200
cadence-list 2 100 200 100 400
Related Commands
Command
|
Description
|
cadence-max-off-time
|
Specifies the maximum off duration for detection of a tone.
|
cadence-min-on-time
|
Specifies the minimum on duration for detection of a tone.
|
voice class dualtone
|
Creates a voice class for FXO tone detection parameters.
|
cadence-max-off-time
To specify the maximum off duration for detection of a tone, use the cadence-max-off-time command in voice-class configuration mode. To restore the default, use the no form of this command.
cadence-max-off-time time
no cadence-max-off-time
Syntax Description
time
|
The maximum off time of a tone that can be detected, in 10-millisecond increments. Range is from 0 to 5000 (0 milliseconds to 50 seconds). The default is 0.
|
Defaults
No cadence maximum off time is configured
Command Modes
Voice-class configuration
Related Commands
Release
|
Modification
|
12.1(3)T
|
This command was introduced on the Cisco 2600 series, Cisco 3600 series and the Cisco MC3810.
|
Usage Guidelines
You must specify a time value greater than the off time of the tone to be detected. You must specify a time value greater than 0 to enable detection of a tone. With the default (0), the router detects only a continuous tone.
Examples
The following example shows configuration of a maximum off duration of 20 seconds for voice class 100:
cadence-max-off-time 2000
Related Commands
Command
|
Description
|
cadence-min-on-time
|
Specifies the minimum on duration for detection of a tone.
|
cadence-variation
|
Specifies the cadence variation time allowed for detection of a tone.
|
voice class dualtone
|
Creates a voice class for FXO tone detection parameters.
|
cadence-min-on-time
To specify the minimum on duration for detection of a tone, use the cadence-min-on-time command in voice-class configuration mode. To restore the default, use the no form of this command.
cadence-min-on-time time
no cadence-min-on-time
Syntax Description
time
|
The minimum on time of a tone that can be detected, in 10-millisecond increments. Range is from 0 to 100 (0 milliseconds to 1 seconds). The default is 0.
|
Defaults
No cadence minimum on time is configured
Command Modes
Voice-class configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced on the Cisco 2600 series, 3600 series and the Cisco MC3810.
|
Usage Guidelines
You must specify a time value shorter than the on time of the tone to be detected. With the default (0), a tone of any length is detected.
Examples
The following example shows configuration of a minimum on duration of 30 milliseconds for voice class 100:
Related Commands
Command
|
Description
|
cadence-max-off-time
|
Specifies the maximum off duration for detection of a tone.
|
cadence-variation
|
Specifies the cadence variation time allowed for detection of a tone.
|
voice class dualtone
|
Creates a voice class for Foreign Exchange Office (FXO) tone detection parameters.
|
cadence-variation
To specify the cadence variation time allowed for detection of a tone, use the cadence-variation command in voice-class configuration mode. To restore the default cadence variation time, use the no form of this command.
cadence-variation time
no cadence-variation
Syntax Description
time
|
The maximum time by which the tone onset can vary from the specified onset time and still be detected, in 10-millisecond increments. Range is from 0 to 200 (0 milliseconds to 2 seconds). The default is 0.
|
Defaults
0 milliseconds
Command Modes
Voice-class configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced on the Cisco 2600, Cisco 3600 series and the Cisco MC3810.
|
12.1(5)XM
|
This command was implemented on the Cisco 2600, Cisco 3600 series and the Cisco MC3810.
|
12.2(2)T
|
This command was integrated into Cisco IOS Release 12.2(2)T and implemented on the Cisco 1750 router.
|
Usage Guidelines
You should specify a time value greater than the cadence variation of the tone to be detected. With the default of 0, only those tones that match the configured cadence is detected.
This command creates a detection limit for one parameter within a voice class. You can apply the detection limit to any voice port.
Cadence minimum on times and maximum off times are configured automatically.
Examples
The following example specifies a cadence variation time of 30 milliseconds for voice class 100:
The following example specifies 80 ms (eight 10-ms time intervals) as the maximum allowable cadence variation in voice class 70:
voice class dualtone-detect-params 70
Related Commands
Command
|
Description
|
cadence-max-off-time
|
Specifies the maximum off duration for detection of a tone.
|
cadence-min-on-time
|
Specifies the minimum on duration for detection of a tone.
|
supervisory answer dualtone
|
Enables answer supervision on a voice port.
|
supervisory dualtone-detect-params
|
Assigns the boundary and detection tolerance parameters defined by the voice class dualtone-detect-params command to a voice port.
|
call accounting-template voice
To select an accounting template at a specific location, use the call accounting-template voice command in global configuration mode. To remove a specific accounting template, use the no form of this command.
call accounting-template voice acctTempName url
no call accounting-template voice acctTempName url
Syntax Description
acctTempName
|
Template name.
|
url
|
Location of the template.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(11)T
|
This command was introduced on the following platforms: Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
The template name must have a .cdr extension.
To select call records based on your accounting needs and to specify the location of an accounting template that defines the applicable vendor-specific attributes (VSAs) for generating those selected call records, use the call accounting-template voice command in global configuration mode.
The acctTempName argument refers to a specific accounting template file that you want to send to the RADIUS server. This template file defines only specific VSAs selected by you to control your call records based on your accounting needs.
Examples
The example below shows the accounting template cdr1 selected from a specific TFTP address.
call accounting-template voice temp-ivr tftp://kyer/santac/cdr/cdr1.cdr
Related Commands
Command
|
Description
|
show call accounting-template voice
|
Shows the VSAs that are contained in the accounting template.
|
call accounting-template voice reload
|
Reloads the accounting template.
|
call accounting-template voice reload
To reload the accounting template, use the call accounting-template voice reload command in privileged EXEC mode.
call accounting-template voice reload acctTempName
Syntax Description
reload
|
Reloads the accounting template from the address (for example, a tftp address) where the template is stored.
|
acctTempName
|
Name of the accounting template.
|
Command Modes
Privileged EXEC
Command History
Release
|
Modification
|
12.2(11)T
|
This command was introduced on the following platforms: Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
Use the call accounting-template voice reload command to reload the template from the URL defined in the call accounting-template voice command. After bootup, if the template file fails to load from the TFTP server, the system tries to automatically reload the file at 5-minute intervals.
Examples
The example below shows how to reload accounting template cdr2.
call accounting-template voice reload cdr2
Related Commands
Command
|
Description
|
call accounting-template voice
|
Selects an accounting template at a specific location
|
gw-accounting aaa
|
Defines and loads the template file at the location defined by the url.
|
show call accounting-template voice
|
Shows the VSAs that are contained in the accounting template.
|
call application alternate
To specify an alternate application to use if the application that is configured in the dial peer fails, use the call application alternate command in global configuration mode. To return to the default behavior, use the no form of this command.
call application alternate [application-name]
no call application alternate
Syntax Description
application-name
|
(Optional) Name of the specific voice application to use if the application in the dial peer fails. If a specific application name is not entered, the gateway uses the DEFAULT application.
|
Defaults
The call is rejected if the application in the dial peer fails.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(11)T
|
This command was introduced.
|
Usage Guidelines
If this command is not configured, calls are rejected when the dial peer that matches the call does not specify a valid voice application.
In releases before Cisco IOS Release 12.2(11)T, the default application (DEFAULT) was automatically triggered if no application was configured in the dial peer or if the configured application failed. The default application is no longer automatically executed unless the call application alternate command is configured.
The application named DEFAULT is a simple application that outputs dial tone, collects digits, and places a call to the dialed number. This application is included in Cisco IOS software; you do not have to download it or configure it by using the call application voice command.
The call application alternate command specifies that if the application that is configured in the dial peer fails, the default voice application is executed. If the name of a specific application is entered, that application is triggered if the application configured in the dial peer fails. If the alternate application also fails, the call is rejected.
If an application name is entered, that application must first be configured on the gateway by using the call application voice command.
Examples
The following example configures the DEFAULT application as the alternate:
call application alternate
The following example configures the application session as the alternate:
call application alternate session
Related Commands
Command
|
Description
|
application
|
Enables a voice application on a dial peer.
|
call application voice
|
Defines the name of a voice application and specifies the location of the TCL or VoiceXML document to load for this application.
|
show call application voice
|
Displays information about voice applications.
|
call application cache reload time
To configure the router to reload the Media Gateway Control Protocol (MGCP) scripts from cache on a regular interval, use the call application cache reload time command in global configuration mode. To set the value to the default, use the no form of this command.
call application cache reload time bg-minutes
no call application cache reload time
Syntax Description
bg-minutes
|
Specifies the number of minutes after which the background process is awakened. This background process checks the time elapsed since the script was last used and whether the script is current:
•If the script has not been used in the last "unload time," it unloads the script and quit. The unload time is not configurable.
•If the script has been used, the background process loads the script from the URL. It compares the scripts, and if they do not match, it begins using the new script for new calls.
|
Defaults
30 minutes
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced on the Cisco AS5300.
|
Examples
The following example displays the call application cache reload time command configured to specify 30 minutes before a background process is awakened:
call application cache reload time 30
Related Commands
Command
|
Description
|
call application voice load
|
Allows reload of an application that was loaded via the MGCP scripting package.
|
show call application voice
|
Displays all TCL or MGCP scripts that are loaded.
|
call application voice
To define the name of a voice application and specify the location of the Tool Command Language (TCL) or VoiceXML document to load for this application, use the call application voice command in global configuration mode. To remove the defined application and all configured parameters associated with it, use the no form of this command.
call application voice application-name location [word]
no call application voice application-name
Syntax Description
application-name
|
Character string that defines the name of the voice application.
|
location
|
Location of the TCL file or VoiceXML document in URL format. Valid storage locations are TFTP, FTP, HTTP, and Flash memory.
|
word
|
(Optional) Text string that defines an attribute-value (AV) pair specified by the TCL script and understood by the RADIUS server.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(4)XH
|
This command was introduced.
|
12.0(7)T
|
This command was integrated into Cisco IOS Release 12.0(7)T. The location argument was added.
|
12.1(3)T
|
The word argument was added for AV pairs.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB
|
This command was modified to support VoiceXML applications and HTTP server locations on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
This command was integrated into Cisco IOS Release 12.2(4)T and implemented on the Cisco 1750.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751. Support for other Cisco platforms is not included in this release.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 2600 series, Cisco 3600 series, Cisco 3725, Cisco 3745, and Cisco 7200 series.
|
12.2(11)T
|
This command was implemented for VoiceXML applications. This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850 in this release.
|
12.2(15)T
|
MCID AV-pairs were added to the word argument, and they are mcid-dtmf, mcid-release-timer, and mcid-retry-limit.
|
Usage Guidelines
Use this command when configuring interactive voice response (IVR) or one of the IVR-related features (such as Debit Card) to define the name of an application and to identify the location of the TCL script or VoiceXML document associated with the application.
A voice application must be configured by using this command before the application can be configured with the application command in a dial peer.
TCL scripts and VoiceXML documents can be stored in any of the following locations: onTFTP, FTP, or HTTP servers, in the Flash memory of the gateway, or on the removable disks of the Cisco 3600 series. The audio files that they use can be stored in any of these locations, and on Real-Time Streaming Protocol (RTSP) servers.
HTTP is the recommended protocol for loading applications and audio prompts because of its efficient design for loading information over the web. For example, it has methods for determining how long a file can be cached and whether a cached file is still valid.
Include the file type extension in the filename (.vxml or .tcl) when specifying the document used by the application. TCL files require the extension .tcl, and VoiceXML documents require .vxml.
Note The no call application voice command causes all related call application commands—for instance, call application voice language and call application voice set-location—to be deleted. The no call application voice application-name command removes the entire application and all parameters, if configured.
Examples
The following example defines the fax-relay application and the TFTP server location of the associated TCL script:
call application voice fax-relay tftp://keyer/faxrelay.tcl
The following example defines the application "prepaid" and the TFTP server location of the associated TCL script:
call application voice prepaid tftp://keyer/debitcard.tcl
The following is an example of AV pair configuration:
set avsend(h323-ivr-out,)) "payphone:true"
set avsend(323-ivr-out,1) "creditTime:3400"
The AV pair (after the array is defined, as in the prior example) must be sent to the server using the authentication, authorization, and accounting (AAA) authenticate or AAA authorize verbs as follows:
aaa authenticate $account $password $avsend
The script would use this AV pair whenever it is needed to convey information to the RADIUS server that cannot be represented by the standard vendor-specific attributes (VSAs).
The following example shows how to define the VoiceXML application "vapptest1" and the Flash memory location of the associated VoiceXML document "demo0.vxml":
call application voice vapptest1 flash:demo0.vxml
The following example specifies the MCID application name, the TFTP server location of the associated TCL script, and the AV-pairs associated with the MCID application:
call application voice mcid tftp://keyer/mcid.tcl
call application voice mcid mcid-dtmf
call application voice mcid-retry-limit 3
call application voice mcid mcid-release-timer 60
Related Commands
Command
|
Description
|
application
|
Defines the call application in the dial peer.
|
call application voice language
|
Defines the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script or VoiceXML document.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Defines the telephone number to which a call is redirected for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice security trusted
|
Sets the security level of a VoiceXML application to trusted so that ANI is not blocked.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
show call application voice
|
Displays information about voice applications.
|
call application voice access-method
To specify the access method for two-stage dialing for the designated application, use the call application voice access-method command in global configuration mode. To restore default values for this command, use the no form of this command.
call application voice application-name access-method {prompt-user | redialer}
no call application voice application-name access-method
Syntax Description
application-name
|
Name of the application.
|
prompt-user
|
Specifies that no DID is set in the incoming POTS dial peer and that a TCL script in the incoming POTS dial peer is used for two-stage dialing.
|
redialer
|
Specifies that no DID is set in the incoming POTS dial peer and that the redialer device are used for two-stage dialing.
|
Defaults
Prompt-user (when DID is not set in the dial peer)
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into the Cisco IOS Release 12.1(5)T.
|
12.2(4)T
|
This command was introduced on the Cisco 1750.
|
Usage Guidelines
Use the call application voice access-method command to specify the access method for two-stage dialing when DID is disabled in the POTS dial peer.
Examples
The following example specifies prompt-user as the access method for two-stage dialing for the app_libretto_onramp9 IVR application:
call application voice app_libretto_onramp9 access-method prompt-user
Related Commands
Command
|
Description
|
call application voice
|
Loads a specified application onto the router from the TFTP server and gives it an application name by which it is known on the router.
|
call application voice language
|
Defines the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Defines the telephone number to which a call is redirected—for example, the operator telephone number of the service provider—for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
call application voice account-id-method
To configure the fax detection IVR application to use a particular method to assign the account identifier, use the call application voice account-id-method command in global configuration mode. To remove configuration of this account identifier, use the no form of this command.
call application voice application-name account-id-method {none | ani | dnis | gateway}
no call application voice application-name account-id-method {none | ani | dnis | gateway}
Syntax Description
application-name
|
Name of the defined fax detection IVR application.
|
none
|
Account identifier is blank. This is the default.
|
ani
|
Account identifier is the calling party telephone number (automatic number identification, or ANI).
|
dnis
|
Account identifier is the dialed party telephone number (dialed number identification service, or DNIS).
|
gateway
|
Account identifier is a router-specific name derived from the host name and domain name, displayed in the following format: router-name.domain-name.
|
Defaults
none
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(5)XM
|
This command was introduced for the Cisco AS5300.
|
12.2(2)XB
|
This command was implemented on the Cisco AS5400 and Cisco AS5350.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
12.2(11)T
|
This command was implemented on the Cisco AS5300, the Cisco AS5350, and Cisco AS5400.
|
Usage Guidelines
When an on-ramp application converts a fax into an e-mail, the e-mail contains a field called x-account-id, which can be used for accounting or authentication. The x-account-id field can contain information supplied as a result of this command, such as the calling party's telephone number (ani), the called party's telephone number (dnis), or the name of the gateway (gateway).
This command is not supported by Cisco IOS help; that is, if you type the call application voice fax_detect account-id-method command and a question mark (?), the Cisco IOS help does not supply a list of entries that are valid in place of the question mark.
Examples
The following example sets the fax detection IVR application account identifier to the router-specific name derived from the host name and domain name:
call application voice fax_detect account-id-method gateway
Related Commands
Command
|
Description
|
call application voice
|
Loads a specified IVR application onto the router from the TFTP server and gives it an application name by which it is known on the router.
|
call application voice fax-dtmf
|
Configures the fax detection IVR application to recognize a specified digit that indicates a fax call in default-voice and default-fax modes.
|
call application voice mode
|
Configures the fax detection IVR application to operate in one of its four modes.
|
call application voice prompt
|
Configures the fax detection IVR application to use the specified audio file as a user prompt in listen-first mode, default-voice mode, or default-fax mode.
|
call application voice voice-dtmf
|
Configures the fax detection IVR application to recognize a specified digit that indicate a voice call in default-voice and default-fax modes.
|
call application voice accounting enable
To enable authentication, authorization, and accounting (AAA) accounting for a Tool Command Language (TCL) application, use the call application voice accounting enable command in global configuration mode. To disable accounting for a TCL application, use the no form of this command.
call application voice application-name accounting enable
no call application voice application-name accounting enable
Syntax Description
application-name
|
Name of the application.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into Cisco IOS Release 12.1(5)T.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 1751, Cisco 2600 series and Cisco 3600 series, Cisco 3725 and Cisco 3745.
|
Usage Guidelines
This command enables AAA accounting services if a AAA accounting method list has been defined using both the aaa accounting command and the mmoip aaa method fax accounting command.
This command applies to off-ramp store-and-forward fax functions.
Examples
The following example enables AAA accounting to be used with outbound store-and-forward fax:
call application voice app_libretto_onramp9 accounting enable
Related Commands
Command
|
Description
|
aaa accounting
|
Enables AAA accounting of requested services when you use RADIUS or TACACS+.
|
mmoip aaa method fax accounting
|
Defines the name of the method list to be used for AAA accounting with store-and-forward fax.
|
call application voice accounting-list
To define the name of the accounting method list to be used for authentication, authorization, and accounting (AAA) with store-and-forward fax on a voice feature card (VFC), use the call application voice accounting-list command in global configuration mode. To undefine the accounting method list, use the no form of this command.
call application voice application-name accounting-list method-list-name
no call application voice application-name accounting-list method-list-name
Syntax Description
application-name
|
Name of the application.
|
method-list-name
|
Character string used to name a list of accounting methods to be used with store-and-forward fax.
|
Defaults
No AAA accounting method list is defined
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into Cisco IOS Release 12.1(5)T.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the following platforms: Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
Usage Guidelines
This command defines the name of the AAA accounting method list to be used with store-and-forward fax. The method list itself, which defines the type of accounting services provided for store-and-forward fax, is defined using the aaa accounting command. Unlike standard AAA (in which each defined method list can be applied to specific interfaces and lines), the AAA accounting method lists that are used in store-and-forward fax are applied globally.
After the accounting method lists have been defined, they are enabled by using the mmoip aaa receive-accounting enable command.
This command applies to both on-ramp and off-ramp store-and-forward fax functions on VFCs. The command is not used on modem cards.
Examples
The following example defines a AAA accounting method list "smith" to be used with store-and-forward fax:
call application voice app_libretto_onramp9 accounting-list smith
Related Commands
Command
|
Description
|
aaa accounting
|
Enables AAA accounting of requested services when you use RADIUS or TACACS+.
|
call application voice accounting enable
|
Enables AAA accounting for a TCL application.
|
mmoip aaa receive-accounting enable
|
Enables on-ramp AAA accounting services.
|
call application voice accounting-template
To configure T.37 fax accounting with VoIP Authentication, Authorization, and Accounting (AAA) non-blocking Application Programming Interface (API), use the call application voice accounting-template command in global configuration mode. To remove the defined application and all configured parameters associated with it, use the no form of this command.
call application voice application-name accounting-template template-name
no call application voice application-name accounting-template template-name
Syntax Description
application-name
|
Defines the name of the T.37 voice application.
•Use the call application voice command to define the name of a voice application and specify the location of the Tool Command Language (TCL) or VoiceXML document to load for this application.
|
template-name
|
Defines the name of the template.
•Use the call accounting-template voice command to define the template name.
|
Defaults
Disabled
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(1)
|
This command was introduced.
|
Usage Guidelines
This command enables T.37 fax to be consistent with VoIP AAA accounting services, which uses the Cisco IOS software non-blocking APIs. This command creates accounting templates for faxes by associating the template name with the T.37 onramp or offramp application.
You can define an accounting template to specify information that is included in an accounting packet.
Note This command applies only to T.37 fax.
Use the show call active fax and the show call history fax commands to check the configuration.
Examples
The following is an example configuration using the T.37 accounting template:
Router(config)# call accounting-template voice template-name url
Router(config)# call application voice t37_onramp accounting-template template-name
Router(config)# call application voice t37_offramp accounting-template template-name
Related Commands
Command
|
Description
|
application
|
Defines the call application in the dial peer.
|
call accounting-template voice
|
Selects an accounting template at a specific location.
|
call application voice
|
Defines the name of a voice application and specifies the location of the TCL or VoiceXML document to load for this application.
|
call application voice language
|
Defines the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script or VoiceXML document.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Defines the telephone number to which a call is redirected for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice security trusted
|
Sets the security level of a VoiceXML application to trusted so that ANI is not blocked.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
show call active fax
|
Displays call information for fax transmissions in progress.
|
show call application voice
|
Displays information about voice applications.
|
show call history fax
|
Displays the call history table for fax transmissions.
|
call application voice authen-list
To specify the name of an authentication method list for a Tool Command Language (TCL) application, use the call application voice authen-list command in global configuration mode. To disable the authentication method list for a TCL application, use the no form of this command.
call application voice application-name authen-list method-list-name
no call application voice application-name authen-list method-list-name
Syntax Description
application-name
|
Name of the application.
|
method-list-name
|
Character string used to name a list of authentication methods to be used with T.38 fax relay and T.37 store-and-forward fax.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into Cisco IOS Release 12.1(5)T.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 1751, Cisco 2600 series and Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
Usage Guidelines
This command defines the name of the authentication, authorization, and accounting (AAA) method list to be used with fax applications on voice feature cards. The method list itself, which defines the type of authentication services provided for store-and-forward fax, is defined using the aaa authentication command. Unlike standard AAA (in which each defined method list can be applied to specific interfaces and lines), AAA method lists that are used with fax applications are applied globally.
After the authentication method lists have been defined, they are enabled by using the call application voice authentication enable command.
Examples
The following example defines a AAA authentication method list (called "fax") to be used with T.38 fax relay and T.37 store-and-forward fax:
call application voice app_libretto_onramp9 authen-list fax
Related Commands
Command
|
Description
|
aaa authentication
|
Enable AAA accounting of requested services for billing or security purposes.
|
call application voice authen-method
|
Specifies the authentication method for a TCL application.
|
call application voice authentication enable
|
Enables AAA authentication services for a TCL application.
|
call application voice authen-method
To specify an authentication, authorization, and accounting (AAA) authentication method for a Tool Command Language (TCL) application, use the call application voice authen-method command in global configuration mode. To disable the authentication method for a TCL application, use the no form of this command.
call application voice application-name authen-method {prompt-user | ani | dnis | gateway |
redialer-id | redialer-dnis}
no call application voice application-name authen-method {prompt-user | ani | dnis | gateway |
redialer-id | redialer-dnis}
Syntax Description
application-name
|
Name of the application.
|
prompt-user
|
User is prompted for the TCL application account identifier.
|
ani
|
Calling party telephone number (automatic number identification or ANI) is used as the TCL application account identifier.
|
dnis
|
Called party telephone number (dialed number identification service or DNIS) is used as the TCL application account identifier.
|
gateway
|
Router-specific name derived from the host name and domain name is used as the TCL application account identifier, displayed in the following format: router-name.domain-name.
|
redialer-id
|
Account string returned by the external redialer device is used as the TCL application account identifier. In this case, the redialer ID is either the redialer serial number or the redialer account number.
|
redialer-dnis
|
Called party telephone number (dialed number identification service or DNIS) is used as the TCL application account identifier captured by the redialer if a redialer device is present.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into Cisco IOS Release 12.1(5)T.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
Usage Guidelines
Normally, when AAA is used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With T.37 store-and-forward fax and T.38 real-time fax, you can specify that the ANI, DNIS, gateway ID, redialer ID, or redialer DNIS be used to identify the user for authentication or that the user be prompted for the TCL application.
Examples
The following example configures the router-specific name derived from the host name and domain name as the TCL application account identifier for the app_libretto_onramp9 TCL application:
call application voice app_libretto_onramp9 authen-method gateway
Related Commands
Command
|
Description
|
call application voice authentication enable
|
Enables AAA authentication services for a TCL application.
|
call application voice authen-list
|
Specifies the name of an authentication method list for a TCL application.
|
call application voice authentication enable
To enable authentication, authorization, and accounting (AAA) services for a Tool Command Language (TCL) application, use the call application voice authentication enable command in global configuration mode. To disable authentication for a TCL application, use the no form of this command.
call application voice application-name authentication enable
no call application voice application-name authentication enable
Syntax Description
application-name
|
Name of the application.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into Cisco IOS Release 12.1(5)T.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
Usage Guidelines
This command enables AAA authentication services for a TCL application if a AAA authentication method list has been defined using both the aaa authentication command and the call application voice authen-list command.
Examples
The following example enables a AAA authentication method list (called "smith") to be used with outbound store-and-forward fax.
call application voice app_libretto_onramp9 authen-list smith
call application voice app_libretto_onramp9 authentication enable
Related Commands
Command
|
Description
|
aaa authentication
|
Enables AAA accounting of requested services when you use RADIUS or TACACS+.
|
call application voice authen-list
|
Specifies the name of an authentication method list for a TCL application.
|
call application voice authen-method
|
Specifies the authentication method for a TCL application.
|
call application voice dsn-script
To specify the VoiceXML application to which the off-ramp mail application hands off calls for off-ramp Domain Name System (DSN) and message disposition notification (MDN) e-mail messages, use the call application voice dsn-script command in global configuration mode. To remove the application, use the no form of this command.
call application voice mail-application-name dsn-script application-name
no call application voice mail-application-name dsn-script application-name
Syntax Description
mail-application-name
|
Name of the off-ramp mail application that launches the app_voicemail_offramp.tcl script when the gateway receives an e-mail trigger.
|
application-name
|
Name of the VoiceXML application to which the off-ramp mail application hands off the call when the destination answers.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(11)T
|
This command was introduced on the Cisco 3640, Cisco 3660, Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
Usage Guidelines
When the off-ramp gateway receives a DSN or MDN e-mail message, it handles it in the same way as a voice e-mail trigger message. The dial peer is selected on the basis of dial number identification
service (DNIS), and the mail application hands off the call to the VoiceXML application that is configured with this command.
Examples
The following example shows how to define the DSN application and how to apply it to a dial peer:
call application voice offramp-mapp tftp://sample/tftp-users/tcl/app_voicemail_offramp.tcl
call application voice dsn-mapp-test tftp://sample/tftp-users/vxml/dsn-mapp-test.vxml
call application voice offramp-mapp dsn-script dsn-mapp-test
dial-peer voice 1000 mmoip
incoming called-number 555....
Related Commands
Command
|
Description
|
application
|
Defines a specific voice application in the dial peer.
|
call application voice
|
Defines the name of a voice application and specifies the location of the document (TCL or VoiceXML) to load for the application.
|
show call application voice
|
Displays information about the configured voice applications.
|
call application voice fax-dtmf
To direct the fax detection interactive voice response (IVR) application to recognize a specified digit to indicate a fax call in default-voice and default-fax modes, use the call application voice fax-dtmf command in global configuration mode. To remove configuration of this digit, use the no form of this command.
call application voice application-name fax-dtmf {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | * | #}
no call application voice application-name fax-dtmf {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | * | #}
Syntax Description
application-name
|
The name of the fax detection IVR application that you defined when you loaded the application on the router.
|
0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | * | #
|
The telephone keypad digit processed by the calling party to indicate a fax call, in response to the audio prompt that plays during the default-voice or default-fax mode of the fax detection IVR application.
|
Defaults
2
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(5)XM
|
This command was introduced for the Cisco AS5300.
|
12.2(2)T
|
This command was integrated into Cisco IOS Release 12.2(2)T.
|
12.2(2)XB
|
This command was implemented on the Cisco AS5400 and Cisco AS5350.
|
12.2(8)T
|
This command was implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
12.2(11)T
|
This command was implemented on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
Usage Guidelines
This command is useful only when the fax detection IVR application is being configured in default-voice mode or default-fax mode as defined by the call application voice mode command.
Only one digit can be specified in this command, and that digit must be different from the digit specified in the call application voice voice-dtmf command. You are not notified immediately if you make the error of configuring them both to the same digit. To find this error, you must start the debugging with the debug voip ivr script command and then observe some failing calls.
This command is not supported by Cisco IOS help; that is, if you type call application voice fax_detect fax-dtmf and a question mark (?), Cisco IOS help does not supply a list of entries that are valid in place of the question mark.
Examples
The following example selects DTMF digit 1 to indicate a fax call:
call application voice fax_detect script_url
call application voice fax_detect fax-dtmf 1
Related Commands
Command
|
Description
|
call application voice
|
Loads an IVR application onto a router and gives it an application name.
|
call application voice account-id-method
|
Configures the fax detection IVR application to use a particular method to assign the account identifier.
|
call application voice mode
|
Configures the fax detection IVR application to operate in one of its four modes.
|
call application voice prompt
|
Configures the fax detection IVR application to use the specified audio file as a user prompt.
|
call application voice voice-dtmf
|
Configures the fax detection IVR application to recognize the specified digit to indicate a voice call.
|
debug voip ivr script
|
Displays debug information from the fax detection IVR script.
|
call application voice global-password
To define a password to be used with CiscoSecure for Windows NT when using store-and-forward fax on a voice feature card, use the call application voice global-password command in global configuration mode. To restore the default value, use the no form of this command.
call application voice application-name global-password password
no call application voice application-name global-password password
Syntax Description
application-name
|
The name of the application.
|
password
|
Character string used to define the CiscoSecure for Windows NT password to be used with store-and-forward fax. The maximum length is 64 alphanumeric characters.
|
Defaults
No password is defined
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)XI
|
This command was introduced on the Cisco AS5300.
|
12.1(5)T
|
This command was integrated into Cisco IOS Release 12.1(5)T.
|
Usage Guidelines
CiscoSecure for Windows NT might require a separate password to complete authentication, no matter what security protocol you use. This command defines the password to be used with CiscoSecure for Windows NT. All records on the Windows NT server use this defined password.
This command applies to on-ramp store-and-forward fax functions on Cisco AS5300 universal access server voice feature cards. It is not used on modem cards.
Examples
The following example shows a password (abercrombie) being used by AAA for the app_libretto_onramp9 TCL application:
call application voice app_libretto_onramp9 global-password abercrombie
call application voice language
To specify the language for dynamic prompts used by an interactive voice response (IVR) application (Tool Command Language (TCL) or VoiceXML), use the call application voice language command in global configuration mode. To remove this language specification from the application, use the no form of this command.
call application voice application-name language digit language
no call application voice application-name language digit language
Syntax Description
application-name
|
Name of the application to which the language parameters are being passed.
|
digit
|
Number that identifies the language used by the audio files. Any number can represent any language. Enter 1 to indicate the primary language and 2 to indicate the secondary language. Range is from 0 to 9.
|
language
|
Two-character code that identifies the language of the associated audio files. Valid entries are as follows:
•en—English
•sp—Spanish
•ch—Mandarin
•aa—all
|
Defaults
If this command is not configured, the default language is English.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB
|
This command was modified to support VoiceXML applications on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 7200 series. Support for the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800 and Cisco AS5850 is not included in this release.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T for VoiceXML applications. This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco 5800, and Cisco AS5850 in this release.
|
Usage Guidelines
This command identifies the number that users enter for a language; for example, "Enter 1 for English. Enter 2 for French."
This number is used only with the TCL IVR Debit Card feature. Although it is not used by VoiceXML, you still must enter a number from 0 to 9.
Instead of using this command, you can configure the language and location of the prerecorded audio files within a TCL script or VoiceXML document. For more information, refer to the TCL IVR API Version 2.0 Programmer's Guide or Cisco VoiceXML Programmer's Guide, respectively.
To identify the location of the language audio files that are used for the dynamic prompts, use the call application voice set-location command.
TCL scripts and VoiceXML documents can be stored in any of the following locations: On the TFTP, FTP, or HTTP servers, in the Flash memory of the gateway, or on the removable disks of the Cisco 3600 series. The audio files that they use can be stored in any of these locations, and on RTSP servers.
With the Pre-Paid Debitcard Multi-Language feature, you can create TCL scripts and a two-character code for any language. Refer to the Cisco Pre-Paid Debitcard Multi-Language Programmer's Reference.
With the multilanguage support for Cisco IOS IVR, you can create a TCL language module for any language and any set of TTS notations for use with TCL and VoiceXML applications. Refer to the Enhanced Multi-Language Support for Cisco IOS Interactive Voice Response document.
Table 5 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 5 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4.
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
This script authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
This script authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
This script authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to define the application "prepaid" and then selects English and Spanish as the languages of the audio files that are associated with the application:
call application voice prepaid tftp://keyer/debitcard.tcl
call application voice prepaid language 1 en
call application voice prepaid language 2 sp
Related Commands
Command
|
Description
|
call application voice
|
Specifies the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Specifies the telephone number to which a call is redirected for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
show call application voice
|
Displays information about voice applications.
|
call application voice load
To reload the selected voice application script after it has been modified, use the call application voice load command in privileged EXEC mode. This command does not have a no form.
call application voice load application-name
Syntax Description
application-name
|
Name of the TCL or VoiceXML application to reload.
|
Defaults
No default behavior or values
Command Modes
Privileged EXEC
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced on the Cisco 2600 series and Cisco 3600 series (except for the Cisco 3660), and on the Cisco AS5300.
|
12.1(3)T
|
Support for dynamic script loading of Media Gateway Control Protocol (MGCP) was added.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB
|
This command was modified to support VoiceXML applications.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751.
|
12.2(4)T
|
This command was integrated into Cisco IOS Release 12.2(4)T and implemented on the Cisco 1750.
|
12.2(8)T
|
This command and implemented on the Cisco 7200 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T for VoiceXML applications. This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and the Cisco AS5850 in this release.
|
Usage Guidelines
Use this command to reload an application TCL script or VoiceXML document onto the gateway after it has been modified.
The location of the TCL script or VoiceXML document for the specified application must have already been configured using the call application voice command.
Do not include the file type extension in the filename (.vxml or .tcl) when specifying the document used by the application.
TCL scripts and VoiceXML documents can be stored in any of the following locations: on TFTP, FTP, or HTTP servers, in the Flash memory of the gateway, or on the removable disks of the Cisco 3600 series. The audio files that they use can be stored on any of these locations, and on RTSP servers.
Before Cisco IOS Release 12.1(3)T, the software checked the signature in a TCL script to ensure that it was supported by Cisco. A signature on TCL scripts is no longer required. A signature has never been required for VoiceXML documents.
A TCL script or VoiceXML document cannot be reloaded if it has active calls. Use the show call application voice command to verify that no active calls are using this application.
Tip If the call application voice load command fails to load the TCL script or VoiceXML document that is associated with the application, enable the debug voip ivr command and retry. This debugging command can provide information on why loading fails.
Note MGCP scripting is not supported on the Cisco 1750 router or on Cisco 7200 series routers.
Examples
The following example shows the loading of a TCL script called "clid_4digits_npw_3.tcl":
call application voice load clid_4digits_npw_3.tcl
The following example shows how to reload the VoiceXML application called "vapptest":
call application voice load vapptest
Related Commands
Command
|
Description
|
call application cache reload time
|
Configures the interval for reloading MGCP scripts.
|
call application voice
|
Creates and calls the application that interacts with the IVR feature.
|
debug http client
|
Displays information about the load an application that was loaded with HTTP.
|
show call application voice
|
Displays a list of the voice applications that are configured.
|
call application voice mail-script
To specify the VoiceXML application to which the off-ramp mail application hands off a call when the destination telephone answers, use the call application voice mail-script command in global configuration mode. To remove the application, use the no form of this command.
call application voice mail-application-name mail-script application-name
no call application voice mail-application-name mail-script application-name
Syntax Description
mail-application-name
|
Name of the off-ramp mail application that launches the app_voicemail_offramp.tcl script when the gateway receives an e-mail trigger.
|
application-name
|
Name of the VoiceXML application to which the off-ramp mail application hands off the call when the destination answers.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(11)T
|
This command was introduced on the Cisco 3640, Cisco 3660, Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
Usage Guidelines
•To load the mail application onto the gateway, use the call application voice command.
•The off-ramp mail application must be configured in the Multimedia Mail over Internet Protocol (MMoIP) dial peer that matches the telephone number contained in the header of the incoming e-mail message.
•The off-ramp mail application must use the Tool Command Language (TCL) script named "app_voicemail_offramp.tcl" that is provided by Cisco. This TCL script can be downloaded from the Cisco webssite by following this path: Cisco > Technical Support Help - TAC > Select & Download Software > Software Center > Access Software > TCLWare.
Examples
The following example shows that the off-ramp mail application named "offramp-mapp" hands calls to the application named "mapp-test" if the telephone number in the e-mail header is seven digits beginning with 555:
call application voice offramp-mapp tftp://sample/tftp-users/tcl/app_voicemail_offramp.tcl
call application voice mapp-test tftp://sample/tftp-users/vxml/user-test.vxml
call application voice offramp-mapp mail-script mapp-test
dial-peer voice 1001 mmoip
incoming called-number 555....
Related Commands
Command
|
Description
|
application
|
Defines a specific voice application in the dial peer.
|
call application voice
|
Defines the name of a voice application and specifies the location of the document (TCL or VoiceXML) to load for the application.
|
show call application voice
|
Displays information about the configured voice applications.
|
call application voice mode
To direct the fax detection interactive voice response (IVR) application to operate in one of its four connection modes, use the call application voice mode command in global configuration mode. To return to the default connection mode, use the no form of this command.
call application voice application-name mode {connect-first | listen-first | default-voice |
default-fax}
no call application voice application-name mode {connect-first | listen-first | default-voice |
default-fax}
Syntax Description
application-name
|
Fax detection IVR application that was defined when the application was loaded on the router.
|
connect-first
|
Incoming calls are connected to the Real-Time Streaming Protocol (RTSP) server. This is the default.
|
listen-first
|
The gateway listens to the call first and then connects to the RTSP server. Any Dual tone multifrequency (DTMF) tones take the call to the voice server, but subsequent DTMF is forwarded as configured.
|
default-voice
|
Incoming calls are connected as voice calls to the RTSP server.
|
default-fax
|
Incoming calls are connected to the fax relay or store-and-forward fax application that is configured on the gateway.
|
Defaults
connect-first
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(5)XM
|
This command was introduced on the Cisco AS5300.
|
12.2(2)XB
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
12.2(11)T
|
This command is supported on the Cisco AS5300, Cisco AS5350, and Cisco AS5400 in this release.
|
Usage Guidelines
The call application voice mode commands control the way that the gateway handles fax detection IVR applications calls.
When the connect-first keyword is selected and CNG (calling) tones from the originating fax machine are detected, the voice application is disconnected and the call is passed to the configured fax application. If the listen-first keyword is selected, the gateway listens for CNG and, if it is detected, passes the call to the fax relay or store-and-forward fax application, whichever is configured on the gateway. When the default-voice and default-fax keywords are selected, the gateway defaults to voice after listening for CNG or passes the call to the fax relay or store-and-forward fax application, whichever was configured on the gateway. If the gateway hears the Dual tone multifrequency (DTMF) tones that are specified in the call application voice voice-dtmf or call application voice fax-dtmf commands, the call is forwarded as appropriate.
Note that in all four connection modes, the router continues to listen for CNG throughout the call, even if the call has been connected to the voice server; if CNG is detected, the call is connected to fax relay or store-and-forward fax, whichever has been configured.
This command is not supported by Cisco IOS help. If you type the call application voice fax_detect mode command and a question mark (?), Cisco IOS help does not supply a list of valid entries in place of the question mark.
Examples
The following example shows selection of default-voice mode for the fax detection application:
call application voice fax_detect script_url
call application voice fax_detect mode default-voice
Related Commands
Command
|
Description
|
call application voice
|
Loads a specified IVR application onto the router from the TFTP server and gives it an application name by which it is known on the router.
|
call application voice account-id-method
|
Configures the fax detection IVR application to use a particular method to assign the account identifier.
|
call application voice fax-dtmf
|
Configures the fax detection IVR application to recognize a specified digit to indicate a fax call.
|
call application voice prompt
|
Configures the fax detection IVR application to use the specified audio file as a user prompt in listen-first mode, default-voice mode, or default-fax mode.
|
call application voice voice-dtmf
|
Configures the fax detection IVR application to recognize a specified digit to indicate a voice call.
|
call application voice pin-len
To define the number of characters in the personal identification number (PIN) for the designated application, use the call application voice pin-len command in global configuration mode. To disable the PIN for the designated application, use the no form of this command.
call application voice application-name pin-len number
no call application voice application-name pin-len number
Syntax Description
application-name
|
Application name to which the PIN length parameter is being passed.
|
number
|
Number of allowable characters in PINs associated with the specified application. Range is from 0 to 10. The default is 4.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
This command was integrated into Cisco IOS Release 12.2(4)T and implemented on the Cisco 1750.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 7200 series.
|
12.2(11)T
|
This command is supported on the Cisco AS5350, Cisco AS5400 Cisco AS5800, and the Cisco AS5850 in this release.
|
Usage Guidelines
Use this command when configuring interactive voice response (IVR)—depending on the Tool Command Language (TCL) script being used—or one of the IVR-related features (such as Debit Card) to define the number of allowable characters in a PIN for the specified application and to pass that information to the specified application.
Table 6 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 6 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
This script authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
This script authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
This script authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to define a PIN length of 4 characters for the application named "prepaid":
call application voice prepaid pin-len 4
Related Commands
Command
|
Description
|
call application voice
|
Specifies the name to be used for an application and indicates the location of the appropriate IVR script to be used with the application.
|
call application voice language
|
Specifies the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice redirect-number
|
Specifies the telephone number to which a call is redirected for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
call application voice prompt
To direct the fax detection interactive voice response (IVR) application to use the specified audio file as a user prompt, use the call application voice prompt command in global configuration mode. To disable use of this audio file, use the no form of this command.
call application voice application-name prompt prompt-url
no call application voice application-name prompt prompt-url
Syntax Description
application-name
|
The name of the fax detection IVR application that you defined when you loaded the application on the router.
|
prompt-url
|
The URL or Cisco IOS file system (IFS) location on the TFTP server for the audio file containing the prompt for the application.
|
Defaults
The prompt space is empty and no prompt is played.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(5)XM
|
This command was introduced for the Cisco AS5300.
|
12.2(2)XB
|
This command was implemented on the Cisco AS5400 and Cisco AS5350.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
12.2(11)T
|
This command is supported on the Cisco AS5300, Cisco AS5350, and Cisco AS5400 in this release.
|
Usage Guidelines
This command is useful only in the listen-first, default-voice, and default-fax modes of the fax detection application.
Audio files should be a minimum of 9 seconds long so that callers do not hear silence during the initial CNG detection period. Any .au file can be used; formats are described in the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2.
This command is not supported by Cisco IOS help. If you type the call application voice fax_detect prompt command with a question (?), the Cisco IOS help does not supply a list of entries that are valid in place of the question mark.
Examples
The following example associates the audio file" promptfile.au" with the application file "fax_detect", and the application with the inbound POTS dial peer:
call application voice fax_detect script_url
call application voice fax_detect mode default-voice
call application voice fax_detect prompt promptfile.au
Related Commands
Command
|
Description
|
call application voice
|
Loads a specified IVR application onto the router from the TFTP server and gives it an application name by which it is known on the router.
|
call application voice account-id-method
|
Configures the fax detection IVR application to use a particular method to assign the account identifier.
|
call application voice fax-dtmf
|
Configures the fax detection IVR application to recognize a specified digit to indicate a fax call.
|
call application voice mode
|
Configures the fax detection IVR application to operate in one of its four modes.
|
call application voice voice-dtmf
|
Configures the fax detection IVR application to recognize a specified digit to indicate a voice call.
|
call application voice redirect-number
To define the telephone number to which a call is redirected—for example, the operator telephone number of the service provider—for the designated application, use the call application voice redirect-number command in global configuration mode. To cancel the redirect telephone number, use the no form of this command.
call application voice application-name redirect-number number
no call application voice application-name redirect-number number
Syntax Description
application-name
|
Name of the application to which the redirect telephone number parameter is being passed.
|
number
|
Designated operator telephone number of the service provider (or any other number designated by the customer). This is the number where calls are terminated when, for example, allowed debit time has run out or the debit amount is exceeded.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced on the Cisco 2600 series, the Cisco 3600 series, and the Cisco AS5300.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751.
|
12.2(4)T
|
This command was implemented on the Cisco 1750.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 7200 series. Support for the Cisco AS5300, Cisco AS5350, Cisco AS5400, and Cisco AS5850 is not included in this release.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T. This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850 in this release.
|
Usage Guidelines
Use this command when configuring interactive voice response (IVR)—depending on the Tool Command Language (TCL) script being used—or one of the IVR-related features (such as Debit Card) to define the telephone number to which a call is redirected.
Table 7 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 7 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4.
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
This script authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
This script authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
This script authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to define a redirect number for the application named "prepaid":
call application voice prepaid redirect-number 5551111
Related Commands
Command
|
Description
|
call application voice
|
Specifies the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
|
call application voice language
|
Specifies the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
call application voice retry-count
To define the number of times that a caller is permitted to reenter the personal identification number (PIN) for the designated application, use the call application voice retry-count command in global configuration mode. To cancel the retry count, use the no form of this command.
call application voice application-name retry-count number
no call application voice application-name retry-count number
Syntax Description
application-name
|
Name of the application to which the number of possible retries is being passed.
|
number
|
Number of times the caller is permitted to reenter PIN digits. Range is 1 to 5. The default is 3.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751.
|
12.2(4)T
|
This command was introduced on the Cisco 1750.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 7200 series. Support for the Cisco AS5350, Cisco AS5400, and Cisco AS5850 is not included in this release.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T. This command is supported on the Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850 in this release.
|
Usage Guidelines
Use this command when configuring interactive voice response (IVR)—depending on the Tool Command Language (TCL) script being used—or one of the IVR-related features (such as Debit Card) to define how many times a user can reenter a PIN.
Table 8 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 8 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4.
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
This script authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
This script authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
This script authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to define that for the application named "prepaid" that a user can reenter a PIN three times before being disconnected:
call application voice prepaid retry-count 3
Related Commands
Command
|
Description
|
call application voice
|
Specifies the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
|
call application voice language
|
Specifies the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Specifies the telephone number to which a call is redirected for the designated application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
call application voice security trusted
To set the security level of a VoiceXML application to "trusted" so that automatic number identification (ANI) is not blocked, use the call application voice security trusted command in global configuration mode. To restore the default condition, use the no form of this command.
call application voice application-name security trusted
no call application voice application-name security trusted
Syntax Description
application-name
|
Name of the application being configured as trusted.
|
Defaults
The security level of the application is not set to trusted, and ANI is blocked.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.2(2)XB
|
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)t and implemented on the Cisco 3640 and Cisco 3660.
|
Usage Guidelines
This command is applicable only for blocking ANI-to-VoiceXML applications.
Note Tool Command Language (TCL) applications provide the security parameter to the application but do not use it.
If an application is configured as a trusted application, it is trusted not to provide the calling number to the destination party, so ANI is always provided if available.
Normally, the voice gateway does not provide the calling number (ANI) to a VoiceXML application if the caller ID is blocked. Caller ID is blocked if a call that comes into the voice gateway has the presentation indication field set to "presentation restricted". The session.telephone.ani variable is set to "blocked". When the call application voice security trusted command is configured, the gateway does not block caller ID; it provides the calling number to the VoiceXML application.
If the keyword of this command is set to anything other than trusted, the value is accepted and the application is treated as not trusted. For example, in the following configuration, the application "rainshine" is treated as not trusted, and caller ID is blocked:
call application voice rainshine security not_trusted
To enable GTD (Generic Transparency Descriptor) parameters in call signaling messages to map to VoiceXML and TCL session variables, the call application voice security trusted command must be configured. If this command is not configured, the VoiceXML variables that correspond to GTD parameters are marked as not available. For a detailed description of the VoiceXML and TCL session variables, refer to the Cisco VoiceXML Programmer's Guide and the TCL IVR API Version 2.0 Programmer's Guide, respectively.
Examples
The following example configures the application "rainshine" as a trusted application. Caller ID is available to this VoiceXML application if it is supported by the service provider.
call application voice rainshine flash:rainshine.vxml
call application voice rainshine security trusted
The following example configures the application "coldcall" as not trusted. Caller ID can be blocked.
call application voice coldcall tftp://joeserver/sellcars.vxml
no call application voice coldcall security trusted
Related Commands
Command
|
Description
|
call application voice
|
Defines the name of a voice application and specifies the location of the document (TCL or VoiceXML) to load for the application.
|
call application voice language
|
Defines the language of the audio files used for dynamic prompts by the designated application.
|
call application voice load
|
Reloads a TCL or VoiceXML document.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the TCL application. This command is not used by VoiceXML applications.
|
call application voice redirect-number
|
Defines the telephone number to which a call is redirected for the designated application. This command is not used by VoiceXML applications.
|
call application voice retry-count
|
Defines the number of times that a caller is permitted to reenter the PIN for a designated application. This command is not used by VoiceXML applications.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application. This command is not used by VoiceXML applications.
|
call application voice warning-time
|
Defines the number of seconds for which a warning prompt is played before a user's account time runs out. This command is not used by VoiceXML applications.
|
show call application voice
|
Displays the following information associated with a voice application: the audio files, the prompts, the caller interaction, and the abort key operation.
|
call application voice set-location
To define the category and location of audio files that are used for dynamic prompts by the specified IVR application (TCL or VoiceXML), use the call application voice set-location command in global configuration mode. To remove these definitions, use the no form of this command.
call application voice application-name set-location language category location
no call application voice application-name set-location language category location
Syntax Description
application-name
|
Name of the application to which the set-location parameters are being passed.
|
language
|
Two-character code that identifies the language associated with the audio files. Valid entries are as follows:
•en—English
•sp—Spanish
•ch—Mandarin
•aa—all
This is the same language code that was entered by using the call application voice language command.
|
category
|
Category group of the audio files (from 0 to 4). For example, audio files representing the days and months can be category 1, audio files representing units of currency can be category 2, and audio files representing units of time—seconds, minutes, and hours—can be category 3. Range is from 0 to 4; 0 means all categories.
|
location
|
URL of the audio files. Valid URLs refer to TFTP, FTP, HTTP, or RTSP servers, Flash memory, or the removable disks on the Cisco 3600 series.
|
Defaults
No location or category is set.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced on the Cisco 2600 series, Cisco 3600 series, and the Cisco AS5300.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB
|
This command was modified to support VoiceXML applications on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751.
|
12.2(4)T
|
This command was integrated into Cisco IOS Release 12.2(4)T and implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T for VoiceXML applications. This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850 in this release.
|
Usage Guidelines
Instead of using this command, you can configure the language and location of prerecorded audio files within a TCL script or VoiceXML document. For more information, refer to the TCL IVR API Version 2.0 Programmer's Guide or Cisco VoiceXML Programmer's Guide, respectively.
To identify the language of the audio files, use the call application voice language command.
TCL scripts and VoiceXML documents can be stored in any of the following locations: On TFTP, FTP, or HTTP servers, in the Flash memory on the gateway, or on the removable disks of the Cisco 3600 series. The audio files that they use can be stored in any of these locations, and on RTSP servers.
You can configure multiple set-location lines for a single application.
With the Pre-Paid Debitcard Multi-Language feature, you can create TCL scripts and a two-character code for any language. Refer to the Cisco Pre-Paid Debitcard Multi-Language Programmer's Reference.
With the multilanguage support for Cisco IOS IVR, you can create a TCL language module for any language and any set of Text-to-Speech (TTS) notations for use with TCL and VoiceXML applications. Refer to the Enhanced Multi-Language Support for Cisco IOS Interactive Voice Response document.
Table 9 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 9 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
Authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4.
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
Authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
Authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
Authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
Authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to configure the call application voice set-location command for the application named "prepaid". In this example, the language specified is English, the category into which the audio files are grouped is category 0 (meaning all), and the location is the keyer directory on the TFTP server.
call application voice prepaid set-location en 0 tftp://keyer/
The following example shows how to configure the call application voice set-location command for a fictitious VoiceXML application named "rainshine". In this example, as in the preceding example, the language defined is English, the category into which the audio files are grouped is category 0 (meaning "all") and the location is the weathertalk directory on an HTTP server.
call application voice rainshine set-location en 0 http://weathertalk/
The following example shows how to configure the call application voice set-location command for multiple set locations:
call application voice rainshine set-location en 0 http://weathertalk/en_msg/
call application voice rainshine set-location sp 0 http://weathertalk/sp_msg/
call application voice rainshine set-location ch 0 http://weathertalk/ch_msg/
Related Commands
Command
|
Description
|
call application voice
|
Specifies the application name and indicates the location of the IVR script to be used with this application.
|
call application voice language
|
Specifies the audio file language for the designated application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice pin-len
|
Specifies the number of characters in the PIN.
|
call application voice redirect-number
|
Specifies the telephone number to which a call is redirected.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN.
|
call application voice uid-len
|
Defines the number of characters in the UID for the designated application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
show call application voice
|
Displays information about voice applications.
|
call application voice transfer mode
To specify the call-transfer method for Tool Command Language (TCL) or VoiceXML applications, use the call application voice transfer mode command in global configuration mode. To reset to the default, use the no form of this command.
call application voice application-name transfer mode {redirect | redirect-at-alert |
redirect-at-connect | redirect-rotary | rotary}
no call application voice application-name transfer mode
Syntax Description
application-name
|
Name of the voice application for which the transfer method is set.
|
redirect
|
Gateway redirects the call leg to the redirected destination number.
|
redirect-at-alert
|
Gateway places a new call to the redirected destination number and initiates a call transfer when the outgoing call leg is in the alert state. If the call transfer is successful, the two call legs are disconnected on the gateway. If the transfer fails, the gateway bridges the two call legs. Supports Two B-Channel Transfer (TBCT).
|
redirect-at-connect
|
Gateway places a new call to the redirected destination number and initiates a call transfer when the outgoing call leg is in the connect state. If the call transfer is successful, the two call legs are disconnected on the gateway. If the transfer fails, the gateway bridges the two call legs. Supports TBCT.
|
redirect-rotary
|
Gateway redirects the call leg to the redirected destination number. If redirection fails, the gateway places a rotary call to the redirected destination number and hairpins the two call legs. For TBCT, this mode is the same as redirect-at-connect.
|
rotary
|
Gateway places a rotary call for the outgoing call leg and hairpins the two call legs. Call redirection is not invoked. This is the default.
|
Defaults
Rotary method; call redirection is not invoked.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(1)
|
This command was introduced.
|
Usage Guidelines
•This command determines whether a voice application can invoke TBCT or RTPvt.
•Redirect-rotary is the preferred transfer method because it ensures that a call-redirect method is always selected if the call leg is capable of it.
•TCL scripts can read the value of this command by using the info tag get cfg_avpair transfer-mode statement. For detailed information, refer to the TCL IVR API Version 2.0 Programmer's Guide.
•For VoiceXML applications, the value of this command becomes the default behavior if the com.cisco.transfer.mode property is not specified in the VoiceXML document. For detailed information, refer to the Cisco VoiceXML Programmer's Guide. The VoiceXML document property takes precedence over the gateway configuration.
•Before you can use this command, you must configure the named application on the gateway by using the call application voice command.
Examples
The following example sets the transfer method to redirect for the application callme:
call application voice callme transfer mode redirect
Related Commands
Command
|
Description
|
application
|
Enables a voice application on a dial peer.
|
call application voice
|
Defines the name of a voice application and specifies the location of the TCL or VoiceXML document to load for this application.
|
call application voice transfer reroute-mode
|
Specifies the call-forwarding behavior of a TCL application.
|
debug voip ivr callsetup redirect
|
Displays debugging information about H.450 calls that are redirected during setup.
|
debug voip ivr redirect
|
Displays debugging information about redirected H.450 calls.
|
isdn supp-service tbct
|
Enables ISDN TBCT on PRI trunks.
|
show call active voice redirect
|
Displays information about active calls that are being redirected using RTPvt or TBCT.
|
show call application voice
|
Displays information about voice applications.
|
show call history voice redirect
|
Displays history information about calls that were redirected using RTPvt or TBCT.
|
call application voice transfer reroute-mode
To specify the call-forwarding behavior of a Tool Command Language (TCL) application, use the call application voice transfer reroute-mode command in global configuration mode. To reset to the default, use the no form of this command.
call application voice application-name transfer reroute-mode {none | redirect | redirect-rotary
| rotary}
no call application voice application-name transfer reroute-mode
Syntax Description
application-name
|
Name of the voice application for which the transfer reroute method is set.
|
none
|
Call forwarding is not performed by the voice application.
|
redirect
|
Two call legs are directly connected. Supports RTPvt.
|
redirect-rotary
|
Two call legs are directly connected (redirect). If that fails, the two call legs are hairpinned on the gateway (rotary).
|
rotary
|
Gateway places a rotary call for the outgoing call leg and hairpins the two calls together. Release-to-Pivot (RTPvt) is not invoked. This is the default.
|
Defaults
Rotary method; RTPvt is not invoked.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(1)
|
This command was introduced.
|
Usage Guidelines
•This command is not supported for VoiceXML applications or for TBCT.
•Redirect-rotary is the preferred transfer method because it ensures that a call-redirect method is always selected, provided that the call leg is capable of it.
•TCL scripts can read the value of this command by using the info tag get cfg_avpair reroute-mode statement. For detailed information, refer to the TCL IVR API Version 2.0 Programmer's Guide.
•Before you can use this command, you must configure the named application on the gateway by using the call application voice command.
Examples
The following example sets the call forwarding method to redirect for the application callme:
call application voice callme transfer reroute-mode redirect
Related Commands
Command
|
Description
|
application
|
Enables a voice application on a dial peer.
|
call application voice
|
Defines the name of a voice application and specifies the location of the TCL or VoiceXML document to load for this application.
|
call application voice transfer mode
|
Specifies the call-transfer behavior of a TCL or VoiceXML application.
|
isdn supp-service tbct
|
Enables ISDN TBCT on PRI trunks.
|
show call active voice redirect
|
Displays information about active calls that are being redirected using RTPvt or TBCT.
|
show call application voice
|
Displays information about voice applications.
|
show call history voice redirect
|
Displays history information about calls that were redirected using RTPvt or TBCT.
|
call application voice uid-length
To define the number of characters in the user identification number (UID) for the designated application and to pass that information to the specified application, use the call application voice uid-length command in global configuration mode. To restore the default setting for this command, use the no form of this command.
call application voice application-name uid-length number
no call application voice application-name uid-length number
Syntax Description
application-name
|
Name of the application to which the UID length parameter is passed.
|
number
|
Number of allowable characters in UIDs that are associated with the specified application. Range is from 1 to 20. The default is 10.
|
Defaults
Number; 10 characters
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced on the Cisco 2600 series, Cisco 3600 series, and the Cisco AS5300.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751. This release does not support any other Cisco platforms.
|
12.2(4)T
|
Support was added for the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 7200 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T. This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850 in this release.
|
Usage Guidelines
Use this command when configuring interactive voice response (IVR)—depending on the Tool Command Language (TCL) script being used—or one of the IVR-related features (such as Debit Card) to define the number of allowable characters in a UID for the specified application and to pass that information to the specified application.
Table 10 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 10 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
Authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4.
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
Authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
Authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
Authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
Authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to configure four allowable characters in the UID for the application named "prepaid":
call application voice prepaid uid-length 4
Related Commands
Command
|
Description
|
call application voice
|
Specifies the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
|
call application voice language
|
Specifies the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Specifies the telephone number to which a call is redirected for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice warning-time
|
Defines, in seconds, how long in advance a user is warned before the allowed calling time expires for the designated application.
|
call application voice voice-dtmf
To direct the fax detection interactive voice response (IVR) application to recognize a specified digit to indicate a voice call, use the call application voice voice-dtmf command in global configuration mode. To remove configuration of this digit, use the no form of this command.
call application voice application-name voice-dtmf {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | * | #}
no call application voice application-name voice-dtmf {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | * | #}
Syntax Description
application-name
|
The name of the fax detection application that you defined when you loaded the application on the router.
|
0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | * | #
|
The telephone keypad button pressed by the calling party to indicate a voice call, in response to the audio prompt configured in default-voice and default-fax mode of the fax detection IVR application.
|
Defaults
1
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(5)XM
|
This command was introduced for the Cisco AS5300.
|
12.2(2)XB
|
This command was implemented on the Cisco AS5400 and Cisco AS5350.
|
12.2(8)T
|
This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 1751, Cisco 2600 series, Cisco 3600 series, Cisco 3725, and Cisco 3745. Support for the Cisco AS5300, Cisco AS5350, and Cisco AS5400 is not included in this release.
|
12.2(11)T
|
This command is supported on the Cisco AS5300, Cisco AS5350, and Cisco AS5400 in this release.
|
Usage Guidelines
This command is useful only when the fax detection IVR application is being configured in default-voice mode or default-fax mode, as defined by the call application voice mode command. Only one digit can be specified in this command, and that digit must be different from the digit specified in the call application voice fax-dtmf command. You are not notified immediately if you make the error of configuring them both to the same digit. To find this error, you must start debugging with the debug voip ivr script command and then observe some failing calls.
This command is not supported by Cisco IOS help. If you type the call application voice fax_detect voice-dtmf command and a question mark (?), the Cisco IOS help does not supply a list of entries that are valid in place of the question mark.
Examples
The following example selects digit 2 Dual tone multifrequency (DTMF) to indicate a voice call:
call application voice fax_detect script_url
call application voice fax_detect voice-dtmf 2
Related Commands
Command
|
Description
|
call application voice
|
Loads a specified IVR application onto the router from the TFTP server and gives it an application name by which it is known on the router.
|
call application voice account-id-method
|
Configures the fax detection IVR application to use a particular method to assign the account identifier.
|
call application voice fax-dtmf
|
Configures the fax detection IVR application to recognize a specified digit to indicate a fax call.
|
call application voice mode
|
Configures the fax detection IVR application to operate in one of its four modes.
|
call application voice prompt
|
Configures the fax detection IVR application to use the specified audio file as a user prompt.
|
call application voice warning-time
To define the number of seconds of warning that a user receives before the allowed calling time expires use the call application voice warning-time command in global configuration mode. To remove the configured warning period, use the no form of this command.
call application voice application-name warning-time number
no call application voice application-name warning-time number
Syntax Description
application-name
|
Name of the application to which the warning time parameter is being passed.
|
number
|
Length of the warning period, in seconds, before the allowed calling time expires. Range is from 10 to 600. This argument has no default value.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.0(7)T
|
This command was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco AS5300.
|
12.1(5)T
|
This command was implemented on the Cisco AS5800.
|
12.1(5)XM2
|
This command was implemented on the Cisco AS5350 and Cisco AS5400.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)XM
|
This command was implemented on the Cisco 1751. Support for other Cisco platforms is not included in this release.
|
12.2(4)T
|
This command was integrated into Cisco IOS Release 12.2(4)T and implemented on the Cisco 1750.
|
12.2(8)T
|
This command was implemented on the Cisco 7200 series.
|
12.2(11)T
|
This command is supported on the Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850 in this release.
|
Usage Guidelines
Use this command when configuring interactive voice response (IVR)—depending on the Tool Command Language (TCL) script being used—or one of the IVR-related features (such as Debit Card) to define the number of seconds in the warning period before the allowed calling time expires for the specified application and to pass that information to the specified application.
Table 11 lists TCL script names and the corresponding parameters that are required for each TCL script.
Table 11 TCL Scripts and Commands
TCL Script Name
|
Description
|
Commands to Configure
|
app_libretto_onramp9.tcl
|
Authenticates the account and personal identification number (PIN) using the following: prompt-user, using automatic number identification (ANI), dialed number identification service (DNIS), gateway ID, redialer ID, and redialer DNIS.
|
None
|
app_libretto_offramp5.tcl
|
Authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID.
|
None
|
clid_4digits_npw_3_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. The number of digits allowed for the account number and password, respectively, are configurable through the command-line interface (CLI). If the authentication fails, the script allows the caller to retry. The retry number is also configured through the CLI.
|
call application voice uid-length
Range is 1 to 20. The default is 10.
call application voice pin-length
Range is 0 to 10. The default is 4.
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_col_npw_cli.tcl
|
This script authenticates the account number and PIN, respectively, using ANI and NULL. If the authentication fails, it allows the caller to retry. The retry number is configured through CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_authen_collect_cli.tcl
|
This script authenticates the account number and PIN using ANI and DNIS. If the authentication fails, the script allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_3_cli.tcl
|
This script authenticates using ANI and NULL for account numbers and PINs, respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
clid_col_npw_npw_cli.tcl
|
This script authenticates using ANI and NULL for account and PIN, respectively. If authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected together.
|
call application voice retry-count
Range is 1 to 5. The default is 3.
|
fax_rollover_on_busy.tcl
|
Used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy.
|
voice hunt user-busy
|
Examples
The following example shows how to configure a 30-second warning time for the application named "prepaid":
call application voice prepaid warning-time 30
Related Commands
Command
|
Description
|
call application voice language
|
Specifies the language of the audio file for the designated application and passes that information to the application.
|
call application voice load
|
Reloads the designated TCL script.
|
call application voice location
|
Specifies the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
|
call application voice pin-len
|
Defines the number of characters in the PIN for the application and passes that information to the application.
|
call application voice redirect-number
|
Specifies the telephone number to which a call is redirected for the designated application.
|
call application voice retry-count
|
Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.
|
call application voice set-location
|
Defines the location, language, and category of the audio files for the designated application and passes that information to the application.
|
call application voice uid-length
|
Defines the number of characters in the UID for the designated application and passes that information to the application.
|
call fallback
To enable a call request to fall back to a specific dial peer in case of network congestion, use the call fallback command in dial peer configuration mode. To disable PSTN fallback for a specific dial peer, use the no form of this command.
call fallback
no call fallback
Syntax Description
This command has no arguments or keywords.
Defaults
This command is enabled by default if the call fallback active command is enabled in global configuration mode
Command Modes
Dial peer configuration
Command History
Release
|
Modification
|
12.2(2)XA
|
This command was introduced.
|
12.2(4)T
|
The PSTN Fallback feature and enhancements were introduced on Cisco 7200 series and integrated into Cisco IOS Release 12.2(4)T.
|
12.2(4)T2
|
This command was implemented on the Cisco 7500 series.
|
Usage Guidelines
Disabling the call fallback command for a dial peer causes the call fallback subsystem not to fall back to the specified dial peer. Disabling the command is useful when internetworking fallback capable H.323 gateways with the Cisco CallManager or third-party equipment that does not run fallback.
Connected calls are not affected by this feature.
Examples
The following example disables the call fallback command:
Related Commands
Command
|
Description
|
call fallback active
|
Enables a call request to fall back to alternate dial peers.
|
call fallback cache-size
|
Specifies the call fallback cache size for network traffic probe entries.
|
call fallback cache-timeout
|
Specifies the time after which the cache entries of network conditions are purged.
|
call fallback instantaneous-value-weight
|
Configures the call fallback subsystem to take an average from the last two cache entries for call requests.
|
call fallback jitter-probe num-packets
|
Specifies the number of packets in a jitter probe that are used to determine network conditions.
|
call fallback jitter-probe precedence
|
Specifies the priority of the jitter-probe transmission.
|
call fallback jitter-probe priority-queue
|
Assigns a priority queue for jitter-probe transmissions.
|
call fallback key-chain
|
Specifies use of MD5 authentication for sending and receiving SAA probes.
|
call fallback map address-list
|
Specifies that the call fallback router keep a cache table by IP addresses of distances for several destination peers that are sitting behind the router.
|
call fallback map subnet
|
Specifies that the call fallback router keep a cache table by subnet addresses of distances for several destination peers that are sitting behind the router.
|
call fallback probe-timeout
|
Sets the timeout for an SAA probe for call fallback purposes.
|
call fallback threshold delay loss
|
Specifies that the call fallback threshold use only packet delay and loss values.
|
call fallback threshold icpif
|
Specifies that call fallback use the ICPIF threshold.
|
dial-peer voice number
|
Enters dial peer configuration mode.
|
show call fallback config
|
Displays the call fallback configuration.
|
call fallback active
To enable a call request to fall back to alternate dial peers in case of network congestion, use the call fallback active command in global configuration mode. To disable PSTN fallback, use the no form of this command.
call fallback active
no call fallback active
Syntax Description
This command has no arguments or keywords.
Defaults
This command is disabled by default.
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
The PSTN Fallback feature and enhancements were implemented on Cisco 7200 series and integrated into Cisco IOS Release 12.2(4)T.
|
12.2(4)T2
|
This command was implemented for Cisco 7500 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T.
|
Usage Guidelines
Enabling the call fallback active command determines whether calls should be accepted or rejected on the basis of probing of network conditions. The call fallback active command checks each H.323 call request and rejects the call if the network congestion parameters are greater than the value of the configured threshold parameters of the destination. If this is the case, alternative dial peers are tried from the session application layer.
Use the call fallback threshold delay loss or call fallback threshold icpif command to set the threshold parameters.
Connected calls are not affected by this feature.
Examples
The following example enables the call fallback active command:
Router(config)# call fallback active
Related Commands
Command
|
Description
|
call fallback cache-size
|
Specifies the call fallback cache size for network traffic probe entries.
|
call fallback cache-timeout
|
Specifies the time after which the cache entries of network conditions are purged.
|
call fallback instantaneous-value-weight
|
Specifies the call fallback subsystem to take an average from the last two cache entries for call requests.
|
call fallback jitter-probe num-packets
|
Specifies the number of packets in a jitter probe that are used to determine network conditions.
|
call fallback jitter-probe precedence
|
Specifies the priority of the jitter-probe transmission.
|
call fallback jitter-probe priority-queue
|
Assigns a priority queue for jitter-probe transmissions.
|
call fallback key-chain
|
Specifies use of MD5 authentication for sending and receiving SAA probes.
|
call fallback map address-list
|
Specifies that the call fallback router keep a cache table by IP addresses of distances for several destination peers that are sitting behind the router.
|
call fallback map subnet
|
Specifies that the call fallback router keep a cache table by subnet addresses of distances for several destination peers that are sitting behind the router.
|
call fallback probe-timeout
|
Sets the timeout for an SAA probe for call fallback purposes.
|
call fallback threshold delay loss
|
Specifies that the call fallback threshold use only packet delay and loss values.
|
call fallback threshold icpif
|
Specifies that call fallback use the ICPIF threshold.
|
dial-peer voice number
|
Enters dial peer configuration mode.
|
call fallback cache-size
To specify the call fallback cache size for network traffic probe entries, use the call fallback cache-size command in global configuration mode. To restore the default value, use the no form of this command.
call fallback cache-size number
no call fallback cache-size
Syntax Description
number
|
Cache size, in number of entries. Range is from 1 to 256. The default is 128.
|
Defaults
128 entries
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
The PSTN Fallback feature and enhancements were introduced on Cisco 7200 series and integrated into Cisco IOS Release 12.2(4)T.
|
12.2(4)T2
|
This command was implemented on the Cisco 7500 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T.
|
Usage Guidelines
The cache size can be changed only when the call fallback active command is not enabled.
The overflow process deletes up to one-fourth of the cache entries to allow for additional calls beyond the specified cache size. The cache entries chosen for deletion are the oldest entries in the cache.
Examples
The following example specifies 120 cache entries:
Router(config)# call fallback cache-size 120
When call fallback is already configured, the output is as follows:
Router(config)# call fallback cache-size 128
If the cache size is left unchanged, it can be changed only when fallback is off. Use the no form of the call fallback command to turn fallback off.
Related Commands
Command
|
Description
|
call fallback
|
Enables a call request to fall back to a specific dial peer in case of network congestion
|
call fallback active
|
Enables a call request to fall back to alternate dial peers in case of network congestion.
|
call fallback cache-timeout
|
Specifies the time after which the cache entries of network conditions are purged.
|
show call fallback cache
|
Displays the current ICPIF estimates for all IP addresses in the cache.
|
show call fallback config
|
Displays the call fallback configuration.
|
call fallback cache-timeout
To specify the time after which the cache entries of network conditions are purged, use the call fallback cache-timeout command in global configuration mode. To disable the call fallback cache-timeout command, use the no form of this command.
call fallback cache-timeout seconds
no call fallback cache-timeout
Syntax Description
seconds
|
Cache timeout value, in seconds. Range is from 1 to 2147483. The default is 600.
|
Defaults
600 seconds
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
The PSTN Fallback feature and enhancements were implemented on the Cisco 7200 series and integrated into Cisco IOS Release 12.2(4)T.
|
12.2(4)T2
|
This command was implemented on the Cisco 7500 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T.
|
Usage Guidelines
Enabling the call fallback cache-timeout command sends a Service Assurance Agent (SAA) probe out to the network to determine the amount of congestion in terms of configured thresholds. The network condition is based upon delay and loss, or Calculated Planning Impairment Factor (ICPIF) thresholds. Use the call fallback threshold delay loss or call fallback threshold icpif commands to set the threshold parameters.
The cache keeps entries for every network congestion-checking probe sent and received between timeouts. The cache updates after each probe returns the current condition of network traffic. To set the probe frequency, use the call fallback probe-timeout command.
When a call comes into the router, the router matches a dial peer and obtains the destination information. The router calls the fallback subsystem to look up the specified destination in its network traffic cache. If the delay/loss or ICPIF threshold exists and is current, the router uses that value to decide whether to permit the call into the Voice over IP (VoIP) network. If the router determines that the network congestion is below the configured threshold (by looking at the value in the cache), the call is connected.
After each call request, the timer is reset. Purging of the cache occurs only when the cache has received no call requests during the timeout period (seconds). When the cache timeout expires, the entire cache is deleted, and a probe is sent to start a new cache entry. A call cannot be completed until this probe returns with network traffic information.
The network congestion probes continue in the background as long as the entry for the last call request remains in the cache.
Examples
The following example specifies and elapsed time of 1,200 seconds before the cache times out:
Router(config)# call fallback cache-timeout 1200
Related Commands
Command
|
Description
|
call fallback active
|
Enables a call request to fall back to alternate dial peers in case of network congestion.
|
call fallback cache-size
|
Specifies the call fallback cache size.
|
call fallback probe-timeout
|
Specifies the time after which the cache entries of network conditions are purged.
|
call fallback threshold delay loss
|
Configures the call fallback threshold to use only packet delay and loss values.
|
call fallback threshold icpif
|
Specifies that call fallback use the ICPIF threshold.
|
show call fallback cache
|
Displays the current ICPIF estimates for all IP addresses in the cache.
|
show call fallback config
|
Displays the call fallback configuration.
|
call fallback instantaneous-value-weight
To configure the call fallback subsystem to take an average from the last two probes registered in the cache for call requests, use the call fallback instantaneous-value-weight command in global configuration mode. To return to the default before the average was calculated, use the no form of this command.
call fallback instantaneous-value-weight weight
no call fallback instantaneous-value-weight
Syntax Description
weight
|
Instantaneous value weight, in expressed as a percentage. Range is from 0 to 100. The default is 66.
|
Defaults
66 percent
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
The PSTN Fallback feature and enhancements were implemented on Cisco 7200 series and integrated into Cisco IOS Release 12.2(4)T.
|
12.2(4)T2
|
This command was implemented on the Cisco 7500 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T.
|
Usage Guidelines
Probes that return the network congestion information are logged into the cache to determine whether the next call request is granted. When the network is regularly busy, the cache entries reflect the heavy traffic conditions. However, one probe may return with low traffic conditions, which is in contrast to normal conditions. All call requests received between the time of this probe and the next, use this entry to determine call acceptance. These calls are allowed through the network, but before the next probe is sent and received, the normal, heavy traffic conditions must have returned. The calls sent through, congest the network and cause worsen traffic conditions.
Use the call fallback instantaneous-value-weight command to gradually recover from heavy traffic network conditions. While the system waits for a call, probes update the cache. When a new probe is received, the weight is set and indicates how much the system is to rely upon the new probe and the previous cache entry. If the weight is set to 50 percent, the system enters a cache entry based upon an average from the new probe and the most recent entry in the cache. Call requests use this blended entry to determine acceptance. This allows the call fallback subsystem to keep conservative measures of network congestion.
The configured weight applies to the new probe first. If the call fallback instantaneous-value-weight command is configured with the default weight of 66 percent, the new probe is given a higher value to calculate the average for the new cache entry.
Examples
The following example specifies a fallback value weight of 50 percent:
Router(config)# call fallback instantaneous-value-weight 50
Related Commands
Command
|
Description
|
call fallback active
|
Enables a call request to fall back to alternate dial peers in case of network congestion.
|
show call fallback config
|
Displays the call fallback configuration.
|
call fallback jitter-probe dscp
To specify the differentiated services code point (dscp) of the jitter-probe transmission, use the call fallback jitter-probe dscp command in global configuration mode. To disable this feature and restore the default value of jitter-probe precedence, use the no form of this command.
call fallback jitter-probe dscp dscp-number
no call fallback jitter-probe dscp
Syntax Description
dscp-number
|
DSCP value. Range is from 0 to 63.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.3(8)T
|
This command was introduced.
|
12.3(9)
|
This command was implemented in Cisco IOS Release 12.3(9).
|
Usage Guidelines
Network devices that support Differentiated Services (DiffServ) use a differentiated services code point (DSCP) in the IP header to select a per-hop behavior (PHB) for a packet. Cisco implements queuing techniques that can base their PHB on the IP precedence or DSCP value in the IP header of a packet. On the basic of DSCP or IP precedence, traffic can be put into a particular service class. Packets within a service class are treated alike.
The call fallback jitter-probe dscp command allows you to set a DSCP for jitter-probe packets. The specified DSCP is stored, displayed, and passed in probing packets to the Service Assurance Agent (SAA). This command enables the router to reserve some bandwidth so that during network congestion some of the jitter-probe packets do not get dropped. This command avoids the conflict that occurs with traditional precedence bits.
The call fallback jitter-probe dscp command is mutually exclusive with the call fallback jitter-probe precedence command. Only one of these command can be enabled on the router. When the call fallback jitter-probe dscp command is configured, the precedence value is replaced with the DSCP value. The no call fallback jitter-probe dscp command restores the default value for precedence.
Examples
The following example specifies the jitter-probe DSCP as 10. DSCP configuration replaces the set jitter-probe precedence value with the DSCP value:
call fallback jitter-probe dscp 10
The following configuration disables the DSCP value and restores the default value for precedence, which is set to 2:
no call fallback jitter-probe dscp
Related Commands
Command
|
Description
|
call fallback active
|
Enables a call request to fall back to alternate dial peers in case of network congestion.
|
call fallback jitter-probe num-packets
|
Specifies the number of packets in a jitter probe that are used to determine network conditions.
|
call fallback jitter-probe precedence
|
Specifies the priority of the jitter-probe transmission.
|
call fallback jitter-probe priority-queue
|
Assigns a priority queue for jitter-probe transmissions.
|
show call fallback config
|
Displays the call fallback configuration.
|
call fallback jitter-probe num-packets
To specify the number of packets in a jitter probe that are used to determine network conditions, use the call fallback jitter-probe num-packets command in global configuration mode. To restore the default number of packets, use the no form of this command.
call fallback jitter-probe num-packets number-of-packets
no call fallback jitter-probe num-packets
Syntax Description
number-of-packets
|
Number of packets. Range is from 2 to 50. The default is 15.
|
Defaults
15 packets
Command Modes
Global configuration
Command History
Release
|
Modification
|
12.1(3)T
|
This command was introduced.
|
12.2(2)XB1
|
This command was implemented on the Cisco AS5850.
|
12.2(4)T
|
The PSTN Fallback feature and enhancements were implemented on Cisco 7200 series and integrated into Cisco IOS Release 12.2(4)T.
|
12.2(4)T2
|
This command was implemented on the Cisco 7500 series.
|
12.2(11)T
|
This command was integrated into Cisco IOS Release 12.2(11)T.
|
Usage Guidelines
A jitter probe, consisting of 2 to 50 packets, details the conditions of the network. More than one packet is used by the probe to calculate an average of delay/loss or Calculated Planning Impairment Factor (ICPIF). After the packets return to the probe, the probe delivers the traffic information to the cache where it is logged for call acceptance/denial. Use the call fallback threshold delay loss or call fallback threshold icpif commands to set the threshold parameters.
To get a more realistic estimate on the network congestion, increase the number of packets. If more probing packets are sent, better estimates of network conditions are obtained, but the bandwidth for other network operations is negatively affected. Use fewer packets when you need to maximize bandwidth.
Examples
The following example specifies 20 packets in a jitter probe:
Router(config)# call fallback jitter-probe num-packets 20
If call fallback has been enabled before the number of jitter-probe packets is configured, the output is as follows:
Router(config)# call fallback jitter-probe num-packets 20
The newly specified number of packets take effect only for new probes.
Related Commands
Command
|
Description
|
call fallback active
|
Enables a call request to fall back to alternate dial peers in case of network congestion.
|
call fallback jitter-probe precedence
|
Specifies the jitter-probe precedence.
|
call fallback jitter-probe priority-queue
|
Assigns a priority queue for jitter-probe transmissions.
|
call fallback threshold delay loss
|
Specifies that the call fallback threshold use only packet delay and loss values.
|
call fallback threshold icpif
|
Specifies that call fallback use the ICPIF threshold.
|
show call fallback config
|
Displays the call fallback configuration.
|
Feedback
