Interactive Voice Response with Version 2.0 Enhancements on Cisco 1700 Series Routers

Table Of Contents

Interactive Voice Response with Version 2.0
Enhancements on Cisco 1700 Series Routers

Feature Overview

TCL IVR Enhancements

MGCP Scripting

RTSP Client Implementation

TCL IVR Prompts Played on IP Call Legs

TCL Verbs

Benefits

Restrictions

Related Features and Technologies

Related Documents

Supported Platforms

Supported Standards, MIBs, and RFCs

Prerequisites

Configuration Tasks

Configuring the Call Application for the Dial Peer

Configuring TCL IVR on the Inbound POTS Dial Peer

Configuring TCL IVR on the Inbound VoIP Dial Peer

Configuring MGCP Scripting

Verifying the TCL IVR Configuration

Configuration Examples

TCL IVR for GW1 Configuration Example

TCL IVR for GW2 Configuration Example

Command Reference

application

audio-prompt load

call application voice

call application voice language

call application voice load

call application voice pin-length

call application voice redirect-number

call application voice retry-count

call application voice set-location

call application voice uid-length

call application voice warning-time

debug voip ivr

rtsp client session history duration

rtsp client session history records

session protocol

show call application voice

show rtsp client session

Glossary

Interactive Voice Response with Version 2.0
Enhancements on Cisco 1700 Series Routers

---

Feature History

Release	Modification
11.3(6)NA2	Cisco interactive voice response (IVR) with unalterable IVR scripts was introduced on the Cisco 2500 series and Cisco 3600 series routers and on the Cisco AS5300 universal access server.
12.0(3)T	The IVR feature was implemented in Cisco IOS Release 12.0(3)T.
12.0(4)XH	The call application voice command was introduced.
12.0(7)T	Support was added for the Cisco 2600 series routers, the call application voice command was implemented in the T-train, and the call application voice load command was introduced.
12.1(3)T	IVR Version 2.0 enhancements were introduced on the Cisco AS5300 universal access server.
12.1(5)T	Support for IVR with Version 2.0 enhancements was added for the Cisco AS5800 universal access server.
12.1(5)XM2	Support for IVR with Version 2.0 enhancements was added for the Cisco AS5350 and Cisco AS5400 universal gateways. Support for IVR Version 2.0 enhancements was added for the Cisco 2500 series, Cisco 2600 series, and Cisco 3600 series routers.
12.2(2)XB1	Support for IVR with Version 2.0 enhancements was added for the Cisco AS5850 universal gateway.
12.2(4)XM	Support for IVR with Version 2.0 enhancements was added for the Cisco 1750 and Cisco 1751 routers. This release does not support any other Cisco platforms.

This document describes the Cisco Interactive Voice Response (IVR) feature and the Tool Command Language (TCL) verbs for the Cisco 1750 and Cisco 1751 routers in Cisco IOS Release 12.2(4)XM. The TCL verbs increase scalability and provides enhanced functionality to the Cisco Voice over IP (VoIP) gateways. The Cisco VoIP gateway software provides IVR post and prepaid application (or the Debit Card feature) and announcement support under both the Media Gateway Control Protocol (MGCP) and H.323 protocols. It also uses Real Time Streaming Protocol (RTSP), which enables an external RTSP server to play announcements and interact with voice mail servers.

---

Note Media Gateway Control Protocol (MGCP) scripting is not supported on the Cisco 1750 router.

---

This document includes the following sections:

•Feature Overview

•Supported Platforms

•Supported Standards, MIBs, and RFCs

•Prerequisites

•Configuration Tasks

•Configuration Examples

•Command Reference

•Glossary

Feature Overview

IVR consists of simple voice prompting and digit collection to gather caller information for authenticating the user and identifying the destination. IVR applications can be assigned to specific ports or invoked on the basis of dialed number identification service (DNIS). An IP Public Switched Telephone Network (PSTN) gateway can have several IVR applications to accommodate many different gateway services, and you can customize the IVR applications to present different interfaces to the various callers.

IVR systems provide information in the form of recorded messages over telephone lines in response to user input in the form of spoken words, or more commonly dual tone multifrequency (DTMF) signaling. For example, when a user makes a call with a debit card, an IVR application is used to prompt the caller to enter a specific type of information, such as an account number. After playing the voice prompt, the IVR application collects the predetermined number of touch tones and then places the call to the destination phone or system.

IVR uses TCL scripts to gather information and to process accounting and billing. For example, a TCL IVR script plays when a caller receives a voice-prompt instruction to enter a specific type of information, such as a personal identification number (PIN). After playing the voice prompt, the TCL IVR application collects the predetermined number of touch tones and sends the collected information to an external server for user authentication and authorization.

TCL IVR Enhancements

TCL IVR Version 2.0 on the Cisco 1750 and Cisco 1751 routers provides the following enhancements:

•MGCP scripting package implementation (not supported on the Cisco 1750 router)

•RTSP client implementation

•TCL IVR prompt playout and digit collection on IP call legs

•New TCL verbs to use RTSP scripting features

These enhancements add scalability and enable the TCL IVR scripting functionality on VoIP legs. In addition, support for RTSP enables VoIP gateways to play messages from RTSP-compliant announcement servers. The addition of these enhancements also reduces the CPU load and saves memory on the gateway because no packetization is involved. Larger prompts can be played, and the use of an external audio server is allowed.

---

Note TCL IVR Version 2.0 removed the signature locking mechanism requirement.

---

MGCP Scripting

TCL IVR Version 2.0 infrastructure is greatly enhanced with the addition of support for MGCP using the application package model. MGCP defines application packages to run scripts on the media gateways. These application packages initiate scripts on the gateways and receive return values after execution completes. MGCP scripting allows external call agents (CAs) to instruct a media gateway to run a TCL IVR script in order to perform a specific task and return the end result. For example, you can request and collect the PIN and account number from a caller.

Two previously released Cisco VoIP features that can be implemented are Debit Card for Packet Telephony and TCL IVR. Both features use the TCL scripting language. The TCL scripts that run with MGCP are written in TCL IVR API Version 2.0 and can receive calls through handoff. MGCP scripts can run any TCL command.

---

Note For more information about MGCP, refer to the Cisco IOS Voice, Video, and Fax Command Reference, Cisco IOS Release 12.2.

---

Figure 1 displays the CA that is controlling the TCL IVR scripts. MGCP is the protocol that is running on the CA. The RTSP server is configured to interact with the gateways that have TCL IVR scripts installed and running. The RADIUS server that is running authentication, authorization, and accounting (AAA) also interacts with the gateways.

Figure 1 MGCP Control of TCL IVR Scripts

RTSP Client Implementation

RTSP is an application-level protocol used to control the delivery of data that has real-time properties. Using RTSP also enables an external RTSP server to play announcements and interact with voice mail servers. It provides an extensive framework to enable control and to perform on-demand delivery of real-time data. For example, RTSP is used to control the delivery of audio streams from an audio server.

If you use an RTSP server in your network with VoIP gateways, a scripting application can run on the gateway and connect calls with audio streams from an external audio server. Using RTSP also has the following benefits:

•Reduces the CPU load.

•Allows large prompts to be played that previously demanded high CPU usage from the gateway.

•Saves memory on the gateway because no packetization is involved.

•Allows use of an external audio server, which removes the limitation on the size of the prompt and the number of prompts that can be played out.

TCL IVR Prompts Played on IP Call Legs

TCL IVR Version 2.0 scripts can be configured for incoming plain old telephone service (POTS) or VoIP call legs to play announcements to the user or collect user input (digits). With TCL IVR Version 2.0, the prompts can be triggered from both the PSTN side of the call leg and the IP side of the call leg. This feature enables the audio files (or prompts) to be played out over the IP network.

TCL IVR scripts played toward a VoIP call leg are subject to the following conditions:

•G.711 mu-law encoding must be used when prompts are played.

•G.711 mu-law encoding must also be used for the duration of these calls, even after prompt playout has completed.

•Digital signal processors (DSPs) cannot be on the IP call leg so the script cannot initiate a tone.

•When a TCL IVR script is used to collect digits on a VoIP call leg with H.323 protocol configured on the call leg, one of the following DTMF relay methods must be used:

–Cisco proprietary RTP

–H.245 Alphanumeric IE

–H.245 Signal IE

---

Note For additional information about the dtmf-relay command, refer to the Cisco IOS Voice, Video, and Fax Command Reference.

---

IVR Version 2.0 enables the system to accept calls initiated from the IP side of the network using G.711 and to terminate calls to the terminating gateway using the same codec. Figure 2 displays the TCL IVR application on the gateways controlling the scripts. IP phones can also originate a call to a gateway running a TCL IVR script.

Figure 2 IVR Control of Scripts on an IP Call Leg

TCL Verbs

TCL IVR Version 2.0 delivers a new set of TCL verbs and scripts that replace the previous TCL version. The new TCL verbs enable the user to:

•Use the RTSP audio servers.

•Develop TCL scripts that interact with the IVR application.

•Pass events to the media gateway controller, which is a call agent.

TCL IVR Version 2.0 is not backward compatible with the IVR Version 1.0 scripts.

---

Note For in-depth information about the TCL Version 2.0 verb set and how to develop scripts, refer to Cisco.com (Related Documentation index) and find the document TCL IVR API Version 2.0 Programmer's Guide. The URL is:

http://www.cisco.com/univercd/cc/td/doc/product/access/acs_serv/vapp_dev/index.htm

The guide also contains an annotated example of a TCL IVR script and includes instructions for testing and loading TCL IVR scripts.

---

TCL IVR scripts use the TCL verbs to interact with the gateway during call processing in order to collect the required digits—for example, to request the PIN or account number for the caller. The TCL scripts are the default scripts for all Cisco voice features that use IVR. TCL scripts are configured to control calls coming into or going out of the gateway.

---

Note Ensure that you have loaded the version of TCL scripts that support IVR Version 2. These TCL scripts can be downloaded from the following Cisco.com URL:

http://www.cisco.com/cgi-bin/tablebuild.pl/tclware

---

The TCL IVR scripts listed below are an example of the types of scripts available to be downloaded from the Cisco.com Software Center. For a complete list of scripts, it is recommended that you check the Software Center.

Cisco provides the following TCL IVR scripts:

•fax_hop_on_1—Collects digits from the redialer, such as account number and destination number. When a call is placed to an H.323 network, the set of fields (configured in the call information structure) is "entered", "destination", and "account".

•clid_authen—Authenticates the call with automatic number identification (ANI) and DNIS numbers, collects the destination data, and makes the call.

•clid_authen_npw—Performs as clid_authen, but uses a null password when authenticating, rather than DNIS numbers.

•clid_authen_collect—Authenticates the call with ANI and DNIS numbers and collects the destination data. If authentication fails, it collects the account and password.

•clid_authen_col_npw—Performs as clid_authen_collect, but uses a null password and does not use or collect DNIS numbers.

•clid_col_npw_3—Performs as clid_authen_col_npw except with that script, if authentication with the digits collected (account and PIN) fails, the clid_authen_col_npw script just plays a failure message (auth_failed.au) and then hangs up. The clid_col_npw_3 script allows two failures and then plays the retry audio file (auth_retry.au) and collects the account and PIN again.

The caller can interrupt the message by entering digits for the account number, triggering the prompt to tell the caller to enter the PIN. If authentication fails the third time, the script plays the audio file auth_fail_final.au and hangs up.

Table 1 lists the prompt audio files associated with the clid_col_npw_3 script.

Table 1 clid_col_npw_3 Script Prompt Audio Files

Audio Filename	Action
flash:enter_account.au	Asks the caller to enter an account number. Played as the first request.
flash:auth_fail_retry.au	Asks the caller to reenter the account number. Plays after two failures.
flash:enter_pin.au	Asks the caller to enter a PIN.
flash:enter_destination.au	Asks the caller to enter a destination phone number.
flash:auth_fail_final.au	Informs the caller that the account number authorization has failed three times.

Table 2 lists additional audio files associated with the clid_col_npw_3 script.

Table 2 Additional clid_col_npw_3 Script Audio Files

Audio Filename	Action
auth_fail_retry.au	Informs the caller that authorization failed. Prompts the caller to reenter the account number followed by the pound sign (#).
auth_fail_final.au	Informs the caller, "I'm sorry, your account number cannot be verified. Please hang up and try again."

•clid_col_npw_npw—Tries to authenticate by using ANI, null as the user ID, user, and user password pair. If that fails, it collects an account number and authenticates with account and null. It allows three tries for the caller to enter the account number before ending the call with the authentication failed audio file. If authentication succeeds, it plays a prompt to enter the destination number.

Table 3 lists the audio files associated with the clid_col_npw_npw script.

Table 3 clid_col_npw_npw Script Audio Files

Audio Filename	Action
flash:enter_account.au	Asks the caller to enter the account number the first time.
flash:auth_fail_retry.au	Asks the caller to reenter the account number after the first two failures.
flash:enter_destination.au	Asks the caller to enter the destination phone number.
flash:auth_fail_final.au	Informs the caller that the account number authorization has failed three times.

•clid_col_dnis_3.tcl—Authenticates the caller ID three times. First it authenticates the caller ID with DNIS. If that is not successful, it attempts to authenticate with the caller PIN up to three times.

•clid_col_npw_3.tcl—Authenticates with null. If authentication is not successful, it attempts to authenticate by using the caller PIN up to 3 times.

•clid_4digits_npw_3.tcl—Authenticates with null. If the authentication is not successful, it attempts to authenticate with the caller PIN up to 3 times using the 14-digit account number and password entered together.

•clid_4digits_npw_3_cli.tcl—Authenticates the account number and PIN respectively by using ANI and null. The number of digits allowed for the account number and password are configurable through the command-line interface (CLI). If the authentication fails, it allows the caller to retry. The retry number is also configured through the CLI.

•clid_authen_col_npw_cli.tcl—Authenticates the account number and PIN respectively by using ANI and null. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.

•clid_authen_collect_cli.tcl—Authenticates the account number and PIN by using ANI and DNIS. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI. The account number and PIN are collected separately.

•clid_col_npw_3_cli.tcl—Authenticates by using ANI and null for account and PIN respectively. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.

•clid_col_npw_npw_cli.tcl—Authenticates by 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.

---

Note To display the contents of a TCL IVR script, enter the show call application voice command followed by the name of the desired script.

---

Benefits

This feature provides the following benefits:

•Adds scalability to the IVR infrastructure.

•Reduces the CPU load.

•Allows longer prompts to be played.

•Saves memory on the gateway because no packetization is involved.

•Allows use of an external audio server.

Restrictions

The following restrictions apply to the combination of features described in the "Feature Overview" section:

•TCL IVR Version 1.0 verbs and TCL IVR Version 2.0 verbs cannot be mixed in a script. You write a script using either Version 1.0 verbs or Version 2.0 verbs.

•H.245-alphanumeric DTMF relay does not accurately report the duration of a key press, for example, holding down the pound (#) key for longer than 1 second to register the "long pound" feature. Doing so reports a duration of only 200 milliseconds. Therefore, if an IVR script is configured on the terminating gateway, Cisco proprietary RTP or DTMF relay via H.245 Signal IE must be used.

•RTSP multicast sessions are not supported by the Cisco IOS RTSP client.

•Cisco proprietary RTP, DTMF relay via H.245 Alphanumeric IE, or DTMF relay via H.245 Signal IE must be configured and negotiated on the VoIP call leg to collect digits over a VoIP call leg.

•RTSP is not recommended for dynamic prompt playouts.

Related Features and Technologies

•VoIP

•AAA Functionality on the VoIP Gateway

•RADIUS and H.323 Gateway-Specific Accounting

Related Documents

•Cisco IOS Voice, Video, and Fax Configuration Guide, Cisco IOS Release 12.2

•Cisco IOS Voice, Video, and Fax Command Reference, Cisco IOS Release 12.2

•TCL IVR API Version 1.0 Programmer's Guide

•TCL IVR API Version 2.0 Programmer's Guide

Supported Platforms

•Cisco 1750

•Cisco 1751

Supported Standards, MIBs, and RFCs

Standards

No new or modified standards are supported by this feature.

MIBs

•CISCO-CALL-APPLICATION-MIB

The CISCO-CALL-APPLICATION-MIB supports the management of TCL scripts on the gateway using Simple Network Management Protocol (SNMP). SNMP management support includes monitoring which scripts are loaded, loading a script, and unloading a script.

To obtain lists of supported MIBs by platform and Cisco IOS release, and to download MIB modules, go to the Cisco MIB website on Cisco.com at the following URL:

http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml

RFCs

•RFC 1889, Real Time Protocol

•RFC 2326, Real Time Streaming Protocol

•RFC 2327, Session Description Protocol

Prerequisites

Before you configure your Cisco gateway to support TCL IVR, you must perform the following prerequisite tasks:

•Configure VoIP to support H.323-compliant gateways—meaning that in addition to the basic configuration tasks, such as configuring dial peers and voice ports, you must configure specific devices in your network to act as gateways.

•Configure a TFTP sever to perform storage and retrieval of the audio files, which are required by the Debit Card gateway or other features that require TCL IVR scripts and audio files.

•Download the appropriate TCL IVR script from Cisco.com. Use the copy command to copy your audio file (.au file) to your Flash memory and the audio-prompt load command to read it into RAM. When you use TCL IVR applications, the gateway needs the URL where the TCL script can be found and the URL of any audio file you want to use. Cisco IOS File System (IFS) is used to read the files, so any IFS-supported URLs can be used, which include TFTP, FTP, or a pointer to a device on the router. During configuration of the application, you specify the URLs for the script and for the audio prompt. For more information, refer to the "Using URLs in IVR Scripts" chapter in the TCL IVR API Version 2.0 Programmer's Guide.

•Make sure that your audio files are in the proper format. The TCL IVR prompts require audio file (.au) format of 8-bit, u-law, and 8-kHz encoding. To encode your own audio files, we recommend that you use one of these two audio tools (or a tool of similar quality):

–Cool Edit, manufactured by Syntrillium Software Corporation

–AudioTool, manufactured by Sun Microsystems

•Make sure that your access platform has a minimum of 16 MB of Flash memory and 128 MB of DRAM memory.

•Install and configure the appropriate RADIUS security server in your network. The version of RADIUS that you are using must support IETF-supported vendor-specific attributes (VSAs), which are implemented by using IETF RADIUS attribute 26.

Configuration Tasks

Before starting the software configuration tasks for the TCL IVR Version 2.0 features, complete the following preinstallation tasks:

•Download the TCL scripts and audio files to be used with this feature from Cisco.com.

•Store the TCL scripts and audio files on a TFTP server that is configured to interact with your gateway access server.

•Create the TCL IVR application script to use with the call application voice command when configuring IVR using TCL scripts. You create this application first and store it on a server or location where it can be retrieved by the access server.

•Define the call flow and pass the defined parameter values to the application. Depending on the TCL script that you select, these values can include the language of the audio file and the location of the audio file. Table 4 lists the TCL scripts and the parameter values that they require.

•Associate the application to the incoming POTS or VoIP dial peer.

See the following sections for configuration tasks for TCL IVR. Each task in the list is identified as either required or optional:

•Configuring the Call Application for the Dial Peer (required)

•Configuring TCL IVR on the Inbound POTS Dial Peer (optional)

•Configuring TCL IVR on the Inbound VoIP Dial Peer (optional)

•Configuring MGCP Scripting (optional)

---

Note When an IVR script is used to detect a "long #" from a caller who is connected to the H.323 call leg, the DTMF method used must be either Cisco proprietary RTP or DTMF relay using H.245 Signal IE. DTMF relay using H.245 Alphanumeric IE does not report the actual duration of the digit, causing long pound (#) detection to fail.

---

Configuring the Call Application for the Dial Peer

You must configure the application that interacts with the dial peer before you configure the dial peer. The dial peer collects digits from the caller and uses the application that you have created. Use the call application voice command as shown in the table that follows. Each command line is optional depending on the type of action desired or the digits to be collected.

To configure the application, use the following commands in global configuration mode:

	Command	Purpose
Step 1	Router(config)# call application voice application-name location	Defines the name of the application to be used with your TCL IVR script. The location argument specifies the location of the file and the access protocol in URL format. Some examples are as follows:     flash:scripts/session.tcl     tftp://dirt/sarvi/scripts/session.tcl     ftp://sarvi-ultra/scripts/session.tcl     slot0:scripts/tcl/session.tcl Note You can configure a URL only if the application named application-name has not been configured.
Step 2	Router(config)# call application voice application-name language digit language	Specifies the language that is used by the audio files. An example is: call application voice test language 1 en. The arguments are as follows: •application-name—The name of the application to which the language parameters are being passed. •digit—Maps to the language desired. Use 1 for English. Valid values are 1 through 9. •language—Specifies two characters that represent a language. For example, en for English, sp for Spanish, and ch for Mandarin. Enter aa to represent all languages.
Step 3	Router(config)# call application voice application-name pin-length number	Defines the number of characters in the PIN for the designated application. Valid values are from 0 through 10.
Step 4	Router(config)# call application voice application-name retry-count number	Defines the number of times a caller is permitted to reenter the PIN for the designated application. Valid values are from 1 through 5.
Step 5	Router(config)# call application voice application-name uid-length number	Defines the number of characters allowed to be entered for the user ID for the designated application. Valid values are from 1 through 20.
Step 6	Router(config)# call application voice application-name set-location language category location	Defines the language, category, and location of the audio files for the designated application. An example is: call application voice test set-location en 1 tftp://server_dir/audio_filename.

Table 4 lists TCL script names and the corresponding parameters that are required for each TCL script.

Table 4 TCL Scripts and Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	Authenticates the account number and PIN using ANI and null. The allowed length of digits is configurable through the CLI. If the authentication fails, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 3
clid_authen_col_npw_cli.tcl	Authenticates the account number and PIN using ANI and null. If the authentication fails, it 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	Authenticates the account number and PIN using ANI and DNIS. If the authentication fails, it 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 min = 1, max = 5, default = 3
clid_col_npw_3_cli.tcl	Authenticates using ANI and null for account and PIN. If the authentication fails, it allows the caller to retry. The retry number is configured through the CLI.	call application voice retry-count min = 1, max = 5, default = 3
clid_col_npw_npw_cli.tcl	Authenticates using ANI and null for account and PIN. 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 min = 1, max = 5, default = 3

Configuring TCL IVR on the Inbound POTS Dial Peer

Configuring gateway accounting and AAA is not always required for POTS dial peer configuration. It is dependent upon the type of application that is being used with TCL IVR. For example, the Pre-Paid Calling Card feature requires accounting, and the authentication caller ID application does not.

To configure the inbound POTS dial peer, use the following commands beginning in global configuration mode:

	Command	Purpose
Step 1	Router(config)# aaa new-model	(Optional) Enables AAA security and accounting services.
Step 2	Router(config)# gw-accounting h323	(Optional) Enables gateway-specific H.323 accounting.
Step 3	Router(config)# aaa authentication login h323 radius	(Optional) Defines a method list called H.323 in which RADIUS is defined as the only method of login authentication.
Step 4	Router(config)# aaa accounting connection h323 start-stop group radius	(Optional) Defines a method list called H.323 in which RADIUS is used to perform connection accounting, providing start-stop records.
Step 5	Router(config)# radius-server host ip-address auth-port number acct-port number	Identifies the RADIUS server and the ports that will be used for authentication and accounting services.
Step 6	Router(config)# radius-server key key	Specifies the password used between the gateway and the RADIUS server.
Step 7	Router(config)# dial-peer voice number pots	Enters dial-peer configuration mode to configure the incoming POTS dial peer. The number argument is a tag that uniquely identifies the dial peer.
Step 8	Router(config-dial-peer)# application application-name	Associates the TCL IVR application with the incoming POTS dial peer. Enter the selected TCL IVR application name.
Step 9	Router(config-dial-peer)# destination-pattern [+] string [T]	Enters the telephone number associated with this dial peer. The keywords and arguments are as follows: •Plus sign (+)—(Optional) Indicates an E.164 standard number. •string—Series of digits that specify the E.164 or private dialing plan telephone number. Valid entries are the digits 0 through 9, the letters A through D, and the following special characters: –Asterisk (*) and pound sign (#) that appear on standard touch-tone dial pads. These characters cannot be used as leading characters in a string (for example, *650). –Comma (,) inserts a pause between digits. –Period (.) matches any entered digit (this character is used as a wildcard). The period cannot be used as a leading character in a string (for example, .650). •T—(Optional) Indicates that the destination-pattern value is a variable length dial string.
Step 10	Router(config-dial-peer)# session target ipv4:destination-address	Specifies the session target IP address.

Configuring TCL IVR on the Inbound VoIP Dial Peer

To configure the inbound VoIP dial peer, use the following commands beginning in global configuration mode:

	Command	Purpose
Step 1	Router(config)# dial-peer voice 4401 voip	Enters dial-peer configuration mode and identifies the call leg.
Step 2	Router(config-dial-peer)# application application-name	Associates the TCL IVR application with the incoming VoIP dial peer. Enter the selected TCL IVR application name.
Step 3	Router(config-dial-peer)# destination-pattern string	Enters the destination pattern.
Step 4	Router(config-dial-peer)# session protocol cisco	Specifies the proprietary Cisco VoIP session protocol.
Step 5	Router(config-dial-peer)# session target ipv4:destination-address	Specifies the session target IP address.
Step 6	Router(config-dial-peer)# dtmf-relay cisco-rtp	Specifies the DTMF relay method. The cisco-rtp keyword specifies H.323 and SIP. Other keywords that are available only for H.323 are h245-alphanumeric and h245-signal. Note If digit collection from this VoIP call leg is required, the dtmf-relay command is required. The default is no dtmf-relay.
Step 7	Router(config-dial-peer)# codec g711ulaw	Specifies the voice codec. Note If the configured application will be playing prompts to the VoIP call leg, the g711ulaw keyword is required.

Configuring MGCP Scripting

To perform MGCP scripting, you must enable the MGCP script package. Enable the script in global configuration mode by entering the mgcp package-capability command. The sample MGCP configuration shown in this section is for DS0s on T1 lines. The configuration tasks are as follows:

•Enabling the MGCP service on the DS0 groups

•Enabling the other MGCP packages

•Configuring the call agent address and other MGCP parameters

To configure MGCP scripting, use the following commands beginning in global configuration mode:

	Command	Purpose
Step 1	Router(config)# mgcp	Starts the MGCP daemon.
Step 2	Router(config)# mgcp request timeout timeout	Specifies how long the gateway should wait for a response to a request.
Step 3	Router(config)# mgcp request retries count	Specifies the number of times to retry sending the mgcp command.
Step 4	Router(config)# mgcp call-agent {ipaddr | hostname} [port]	Configures the address of the call agent.
Step 5	Router(config)# mgcp max-waiting-delay value	Configures the maximum waiting delay to be used in a restart in progress (RSIP) message as restart instructions for the call agent.
Step 6	Router(config)# mgcp restart-delay value	Configures the restart delay value to be used in an RSIP message as graceful teardown instructions for the gateway connection.
Step 7	Router(config)# mgcp vad	Configures voice activity detection.
Step 8	Router(config)# mgcp package-capability {as-package | dtmf-package | gm-package | rtp-package | trunk-package}	Specifies an MGCP package capability.
Step 9	Router(config)# mgcp default-package {as-package | dtmf-package | gm-package | rtp-package | trunk-package}	Configures the default package capability type.
Step 10	Router(config)# mgcp quality-threshold {hwm-jitter-buffer value | hwm-latency value | hwm-packet-loss value | lwm-jitter-buffer value | lwm-latency value | lwm-packet-loss value}	Configures the jitter buffer size, packet-loss threshold, and latency threshold.
Step 11	Router(config)# mgcp playout {adaptive init-value min-value max-value | fixed init-value}	Tunes the jitter buffer packet size used for MGCP connections.
Step 12	Router(config)# mgcp codec type [packetization-period value]	Configures the default codec type.
Step 13	Router(config)# mgcp ip-tos {high-reliability | high-throughput | low-cost | low-delay | precedence value}	Enables the IP type of service for MGCP connections.
Step 14	Router(config)# controller t1 slot#	Enters controller configuration mode for the T1 controller in the specified slot.
Step 15	Router(config-controller)# framing type	Configures the framing type.
Step 16	Router(config-controller)# clock source type	Configures the clock source.
Step 17	Router(config-controller)# linecode type	Configures the line coding.
Step 18	Router(config-controller)# ds0-group n timeslots range type signaling-type service mgcp	Configures the DS0s to support MGCP.

Verifying the TCL IVR Configuration

To verify the TCL IVR configuration, perform the following steps:

---

Step 1 Enter the show call application voice summary command to verify that the newly created applications are listed. Sample output follows:

Router# show call application voice summary 

name                 description 

DEFAULT              NEW::Basic app to do DID, or supply dialtone. 

fax_hop_on           Script to talk to a fax redialer 

clid_authen          Authenticate with (ani, dnis) 

clid_authen_collect  Authenticate with (ani, dnis), collect if that fails 

clid_authen_npw      Authenticate with (ani, NULL) 

clid_authen_col_npw  Authenticate with (ani, NULL), collect if that fails 

clid_col_npw_3       Authenticate with (ani, NULL), and 3 tries collecting 

clid_col_npw_npw     Authenticate with (ani, NULL) and 3 tries without pw 

SESSION              Default system session application 

hotwo                tftp://hostname/scripts/nb/nb_handoffTwoLegs.tcl 

hoone                tftp://hostname/scripts/nb/nb_dohandoff.tcl 

hodest               tftp://hostname/scripts/nb/nb_handoff.tcl 

clid                 tftp://hostname/scripts/tcl_ivr/clid_authen_collect.tcl 

db102                tftp://hostname/scripts/1.02/debitcard.tcl 

*hw                  tftp://172.17.184.xxx/tr_hello.tcl 

*hw1                 tftp://san*tr_db               
tftp://172.17.184.235/tr_debitcard.answer.tcl 

TCL Script Version 2.0 supported. 

TCL Script Version 1.1 supported. 

---

Note In the output shown, an asterisk (*) in an application name indicates that this application was not loaded successfully. Use the show call application voice command with the application-name argument to view information for a particular application.

---

Step 2 Enter the show dial-peer voice command with the number argument and verify that the application associated with the dial peer is correct.

Step 3 Enter the show running-config command to display the entire configuration.

---

Configuration Examples

Use the show running-config command to display the entire gateway configuration. Figure 3 shows the type of topology used in the configuration for the examples.

Figure 3 Sample Configuration Topology

In this sample configuration, gateway 1 (GW1) is running TCL IVR for phone A, and gateway 2 (GW2) is running TCL IVR for phone B.

This section provides the following configuration examples:

•TCL IVR for GW1 Configuration Example

•TCL IVR for GW2 Configuration Example

TCL IVR for GW1 Configuration Example

The following output is the result of using the show running-config command for GW1:

Router# show running-config

Building configuration...

Current configuration : 1448 bytes

!

version 12.2

service timestamps debug uptime

service timestamps log uptime

no service password-encryption

!

hostname c1751_uut1

!

no logging console

enable password lab

!

username 1111 password 0 2222

memory-size iomem 15

ip subnet-zero

no ip routing

!

ip host rtsp 172.28.45.123

!

fax interface-type fax-mail

mta receive maximum-recipients 0

!

gw-accounting h323 vsa

gw-accounting voip

!

interface Ethernet0/0

 ip address 10.10.10.10 255.255.255.0

 no ip route-cache

 no ip mroute-cache

 half-duplex

!

interface FastEthernet0/0

 ip address 172.28.37.60 255.255.0.0

 no ip route-cache

 no ip mroute-cache

 speed auto

 half-duplex

!

ip default-gateway 172.28.37.1

ip classless

ip route 0.0.0.0 0.0.0.0 FastEthernet0/0

no ip http server

ip pim bidir-enable

!

call rsvp-sync

!

call application voice myapp 
tftp://172.28.45.123/app_clid_authen_collect_cli_rtsp.2.0.0.tcl

call application voice myapp location rtsp://172.28.45.123/

call application voice myapp uid-length 6

call application voice myapp language 1 en

call application voice myapp language 2 ch

!

voice-port 1/0

!

voice-port 1/1

!

voice-port 2/0

!

voice-port 2/1

!

mgcp profile default

!

dial-peer cor custom

!

dial-peer voice 1 voip

 destination-pattern 1112222

 session target ipv4:172.28.37.63

!

dial-peer voice 2 pots

 application myapp

 destination-pattern 3334444

 port 1/0

!

line con 0

 exec-timeout 0 0

line aux 0

line vty 0 4

 login

!

end

TCL IVR for GW2 Configuration Example

The following output is the result of using the show running-config command for GW2:

Router# show running-config

Building configuration...

Current configuration : 1178 bytes

!

version 12.2

service timestamps debug uptime

service timestamps log uptime

no service password-encryption

!

hostname c2600_uut2

!

no logging console

enable password lab

!

username 1111 password 0 2222

ip subnet-zero

no ip routing

!

fax interface-type fax-mail

mta receive maximum-recipients 0

!

gw-accounting h323 vsa

gw-accounting voip

!

interface FastEthernet0/0

 ip address 172.28.37.63 255.255.0.0

 no ip route-cache

 no ip mroute-cache

 speed auto

 half-duplex

!

interface FastEthernet0/1

 ip address 10.10.10.11 255.255.255.0

 no ip route-cache

 no ip mroute-cache

 speed auto

 half-duplex

!

ip default-gateway 172.28.37.1

ip classless

ip route 0.0.0.0 0.0.0.0 FastEthernet0/0

ip http server

ip pim bidir-enable

ip dns server

!

snmp-server manager

call rsvp-sync

!

voice-port 1/0/0

!

voice-port 1/0/1

!

voice-port 1/1/0

!

voice-port 1/1/1

!

!

mgcp profile default

!

dial-peer cor custom

!

dial-peer voice 1 voip

 destination-pattern 3334444

 session target ipv4:172.28.37.60

!

dial-peer voice 2 pots

 destination-pattern 1112222

 port 1/1/0

!

line con 0

 exec-timeout 0 0

line aux 0

line vty 0 4

 login

!

end

Command Reference

This section documents the following commands related to basic IVR functionality. All other commands used with this feature are documented in the Cisco IOS Release 12.2 command reference publications.

•application

•audio-prompt load

•call application voice

•call application voice language

•call application voice load

•call application voice pin-length

•call application voice redirect-number

•call application voice retry-count

•call application voice set-location

•call application voice uid-length

•call application voice warning-time

•debug voip ivr

•rtsp client session history duration

•rtsp client session history records

•session protocol

•show call application voice

•show rtsp client session

application

To enable a specific application on a dial peer, use the application command in dial-peer configuration mode. To remove the application from the dial peer, use the no form of this command.

application application-name [out-bound]

no application application-name [out-bound]

Syntax Description

application-name

Indicates the name of the predefined application that you wish to enable on the dial peer. For H.323 networks, the application is defined by a Tool Command Language/interactive voice response (TCL/IVR) filename and location. Incoming calls that use plain old telephone service (POTS) dial peers and outgoing calls that use Multimedia Mail over IP (MMoIP) dial peers are handed off to this application. For Media Gateway Control Protocol (MGCP) or Simple Gateway Control Protocol (SGCP) networks, see the usage guidelines below for valid application names.

out-bound

(Optional) The named application will handle the MMoIP dial peer in the outgoing mode.

Defaults

No default behavior or values.

Command Modes

Dial-peer configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced on the Cisco 2500 series and Cisco 3600 series routers and on the Cisco AS5300 universal access server.
12.0(3)T	This command was integrated into Cisco IOS Release 12.0(3)T.
12.0(5)T	The SGCPAPP application was supported initially on the Cisco AS5300 universal access server in a private release that was not generally available.
12.0(7)XK	Support for the SGCPAPP application was extended to the Cisco MC3810 multiservice access concentrator and the Cisco 3600 series routers (except for the Cisco 3620) in a private release that was not generally available.
12.1(2)T	The SGCPAPP application was integrated into Cisco IOS Release 12.1(2)T.
12.1(3)T	The MGCPAPP application was supported initially on the Cisco AS5300 universal access server.
12.1(3)XI	The out-bound keyword was added for the store-and-forward fax feature on the Cisco AS5300 universal access server.
12.1(5)T	The out-bound keyword was integrated into Cisco IOS Release 12.1(5)T, and the command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 routers. This release does not support any other Cisco platforms.

Usage Guidelines

Use this command to associate a predefined session application with an incoming POTS dial peer or an outgoing MMoIP dial peer. Calls that use this incoming POTS dial peer or this outgoing MMoIP dial peer will be handed to the predefined specified session application.

SGCP Networks

For SGCP networks, enter SGCPAPP in uppercase characters. This application can be applied only to POTS dial peers. Note that SGCP dial peers do not use dial peer hunting.

MGCP Networks

For MGCP networks, enter MGCPAPP in uppercase characters. This application can be applied only to POTS dial peers. Note that MGCP dial peers do not use dial peer hunting.

---

Note MGCP scripting is not supported on the Cisco 1750 router.

---

Examples

The following example shows how to define an application and how to apply it to an outbound MMoIP dial peer for the fax onramp operation:

call application voice fax_on_vfc_onramp http://santa/username/clid_4digits_npw_3.tcl

dial-peer voice 3 mmoip

 application fax_on_vfc_onramp out-bound

 destination-pattern 57108..

 session target mailto:$d$@mail-server.cisco.com

The following example shows how to apply the MGCP application to a dial peer:

dial-peer voice 1 pots

 application MGCPAPP

Related Commands

Command	Description
call application voice	Defines the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
mgcp	Starts the MGCP daemon.
sgcp	Starts and allocates resources for the SCGP daemon.
sgcp call-agent	Defines the IP address of the default SGCP call agent.

audio-prompt load

To initiate loading the selected audio file (.au file), the file that contains the announcement prompt for the caller, from Flash memory into RAM, use the audio-prompt load command in privileged EXEC mode. There is no no form of this command.

audio-prompt load name

Syntax Description

name	Indicates the location and filename of the audio file that you want to have loaded from memory, Flash memory, or an FTP server.

Command Modes

Privileged EXEC

Command History

Release	Modification
11.3(6)NA2	This command was introduced.
12.0(3)T	This command was integrated into Cisco IOS Release 12.0(3)T.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Usage Guidelines

The first time the interactive voice response (IVR) application plays a prompt, it reads it from the URL (or the specified location for the .au file, such as Flash memory or an FTP server) into RAM. Then it plays the script from RAM. An example of the sequence of events follows:

1. When the first caller is asked to enter the account and personal identification numbers (PINs), the enter_account.au and enter_pin.au files are loaded into RAM from Flash memory.

2. When the next call comes in, these prompts are played from the RAM copy.

3. If all callers enter valid account numbers and PINs, the auth_failed.au file is not loaded from Flash memory into RAM memory.

The router will load the audio file only when the script initially plays that prompt after the router restarts. If the audio file is changed, you must run this EXEC command to reread the file. This will generate an error message if the file is not accessible or if there is a format error.

---

Note The URL pointer refers to the directory where Flash memory is stored.

---

Examples

The following example shows how to load the enter_pin.au audio file from Flash memory into RAM:

Router# audio-prompt load flash:enter_pin.au

call application voice

To define an application, to indicate the location of the corresponding Tool Command Language (TCL) files that implement this application, and to load the selected TCL script, 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 application.
location	Location of the TCL file in URL format. Valid storage locations are TFTP, FTP, and Flash.
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	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 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 associated with this application.

---

Note The command no call application voice application-name removes the entire application and all parameters, if configured.

---

Examples

This example shows how to define 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 AAA authenticate or 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).

Related Commands

Command	Description
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-length	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 will be 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 application voice warning-time	Defines the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

call application voice language

To define the language of the audio file for the specified application and to pass that information to the specified application, use the call application voice language command in global configuration mode. To remove the associated language of the audio file 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. Valid entries are from 0 to 9.
language	Defines the language of the associated audio file. Valid entries are as follows: •en—English •sp—Spanish •ch—Mandarin •aa—all

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 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 language of the audio file for the specified application and to pass that information to the specified application.

Table 5 lists TCL script names and the corresponding parameters that are required for each TCL script.

Table 5 TCL Scripts and Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

Examples

The following example shows how to define the application "prepaid," then define English and Spanish as the languages of the audio files that are associated with tht 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	Defines 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-length	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 will be 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 application voice warning-time	Defines the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

call application voice load

To reload the selected Tool Command Language (TCL) script from the URL, use the call application voice load command in global configuration mode. There is no no form of this command.

call application voice load application-name

Syntax Description

application-name

Defines the TCL script to use for the call. Enter the name of the TCL or Media Gateway Control Protocol (MGCP) script that you want this dial peer to use. Note MGCP scripting is not supported on the Cisco 1750 router.

Defaults

TCL scripts are not loaded.

Command Modes

Global configuration

Command History

Release	Modification
12.0(7)T	This command was introduced on the Cisco 2600 series routers, the Cisco 3600 series routers (except for the Cisco 3660), and the Cisco AS5300 universal access server.
12.1(3)T	Support for dynamic script loading of MGCP scripts was added.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Examples

The following example shows the reloading of the TCL script called clid_4digits_npw_3.tcl:

call application voice load clid_4digits_npw_3.tcl

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 will interact with the IVR feature.
show call application voice	Displays a list of the voice applications that are configured.

call application voice pin-length

To define the number of characters in the personal identification number (PIN) for the designated application, use the call application voice pin-length command in global configuration mode. To restore default values for this command, use the no form of this command.

call application voice application-name pin-length number

no call application voice application-name pin-length number

Syntax Description

application-name	Name of the application to which the PIN length parameter is being passed.
number	Number of allowable characters in PINs associated with the specified application. Valid entries are 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 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

Examples

The following example shows how to define a PIN length of four characters for the application named prepaid:

call application voice prepaid pin-length 4

Related Commands

Command	Description
call application voice	Defines 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	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 redirect-number	Defines the telephone number to which a call will be 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 application voice warning-time	Defines the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

call application voice redirect-number

To define the telephone number to which a call will be redirected for the designated application, use the call application voice redirect-number command in global configuration mode. To cancel this particular parameter, 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 that calls are terminated to when, for example, debit time allowed 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 routers, the Cisco 3600 series routers, and the Cisco AS5300 universal access server.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 will be redirected.

Table 7 lists TCL script names and the corresponding parameters that are required for each TCL script.

Table 7 TCL Scripts and Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

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	Defines 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	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-length	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-length	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 the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

call application voice retry-count

To define the number of times 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 this particular parameter, 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. Valid entries for this parameter are from 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 on the Cisco 2600 series routers, the Cisco 3600 series routers, and the Cisco AS5300 universal access server.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

Examples

The following example shows how to define that a user can reenter a PIN three times before being disconnected for the application named prepaid:

call application voice prepaid retry-count 3

Related Commands

Command	Description
call application voice	Defines 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	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-length	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 will be 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-length	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 the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

call application voice set-location

To define the language, category, and location of the audio files for the specified application, use the call application voice set-location command in global configuration mode. To cancel this particular parameter, 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	The name of the application to which the set-location parameters are being passed.
language	Defines the language associated with the audio files. Possible values for this parameter follow: •en—English •ch—Mandarin •sp—Spanish
category	Defines a particular category group. Audio files can be divided into category groups (from 0 to 4). For example, audio files that represent the days and months can be category 1, audio files that represent units of currency can be category 2, audio files that represent units of time—seconds, minutes, and hours—can be category 3. The minimum is 0; the maximum is 4 (0 means all).
location	Defines the location (audio file URL or directory in the TFTP server) where the audio files are stored.

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 routers, the Cisco 3600 series routers, and the Cisco AS5300 universal access server.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 language, category, and location of the audio files for the designated application and to pass that information to the application.

Table 9 lists TCL script names and the corresponding parameters that are required for each TCL script.

Table 9 TCL Scripts and Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

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 defined is English, the category into which the audio files are group 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/

Related Commands

Command	Description
call application voice	Defines 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	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-length	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 will be 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 uid-length	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 the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

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 default values 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 being passed.
number	Number of allowable characters in UIDs associated with the specified application. Valid entries are from 1 to 20. The default is 10.

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 routers, the Cisco 3600 series routers, and the Cisco AS5300 universal access server.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

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	Defines 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	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-length	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 will be 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 the number of seconds of warning that a user receives before the allowed calling time runs out for the designated application.

call application voice warning-time

To define the number of seconds of warning that a user receives before the allowed calling time runs out, use the call application voice warning-time command in global configuration mode. To restore default values for this command, 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 runs out. Valid entries are from 10 to 600.

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 routers, the Cisco 3600 series routers, and the Cisco AS5300 universal access server.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

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 runs out 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 Parameters 

TCL Script Name	Description—Summary	Commands to Configure
clid_4digits_npw_3_cli.tcl	This script authenticates the account number and personal identification number (PIN), respectively, using automatic number identification (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, it allows the caller to retry. The retry number is also configured through the CLI.	call application voice uid-length min = 1, max = 20, default = 10 call application voice pin-length min = 0, max = 10, default = 4 call application voice retry-count min = 1, max = 5, default = 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 min = 1, max = 5, default = 3
clid_authen_collect_cli.tcl	This script authenticates the account number and PIN using ANI and dialed number identification service (DNIS). If the authentication fails, it 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 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 min = 1, max = 5, default = 3

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	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 location	Defines 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-length	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 will be 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.

debug voip ivr

To display debug messages for Voice over IP (VoIP) IVR interactions, use the debug voip ivr command in privileged EXEC mode. Interactive voice response (IVR) debug messages appear when a call is actively handled by the IVR scripts. To disable the debug output, use the no form of this command.

debug voip ivr {all | applib | callsetup | digitcollect | dynamic | error | script | settlement | states | tclcommands}

no debug voip ivr {all | applib | callsetup | digitcollect | dynamic | error | script | settlement | states | tclcommands}

Syntax Description

all	Displays all IVR messages.
applib	Displays IVR API libraries that are being processed.
callsetup	Displays IVR call setup information that is being processed.
digitcollect	Displays IVR digits that are collected during the call.
dynamic	Displays IVR dynamic prompt play debug.
error	Displays IVR errors.
script	Displays IVR script debug.
settlement	Displays IVR settlement activities.
states	Displays IVR states.
tclcommands	Displays the Tool Command Language (TCL) commands that are used in the script.

Command Modes

Privileged EXEC

Command History

Release	Modification
11.3(6)NA2	This command was introduced.
12.0(3)T	This command was integrated into Cisco IOS Release 12.0(3)T.
12.0(7)T	The settlement keyword was added for the Settlement for Packet Telephony feature.
12.1(3)T	This command was integrated into Cisco IOS Release 12.1(3)T.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Usage Guidelines

•IVR debug messages appear when a call is actively handled by the IVR scripts.

•Output from the error keyword occurs only if something is not working or an error condition has been raised.

•Output from the states keyword supplies information about the current status of the IVR script and the different events that are occurring in that state.

Examples

The display below shows IVR debug output for the settlement application. The application is using the clid_authen_collect TCL script.

The following output is displayed when the debug voip ivr settlement command is entered:

Router# debug voip ivr settlement

01:00:44:App clid_authen_collect:Handling callID 10

01:00:44:callingNumber=4085550502, calledNumber=4085550304,

redirectNumber=

01:00:44:accountNumber=, finalDestFlag=0,

guid=abea.7a4d.4299.0017.0000.0000.0037.9c94

01:00:44:peer_tag=5

01:00:44:settlement_validate_token:cid(0xA), target=, tokenp=0x0

01:00:44:Accepting CallID=10

01:00:44:authenticate

01:00:44:    account=4085550502

01:00:44:    password=4085550304

01:00:44:cid( 10) running state get_account

01:00:44:ta_PromptCmd. CallID=10

01:00:44:pcapp CallID 10 got event CC_EV_CALL_HANDOFF

01:00:44:prompt and collect app got callID 10

01:00:44:    Playing prompt flash:enter_account.au

01:00:44:    Prompt interrupt enabled

01:00:44:    No return on play complete

01:00:44:    Not matching against dial plan

01:00:44:    Abort key is *    Termination key is #

01:00:44:    Matching against 1 patterns.

01:00:44:        Pattern .+

01:00:44:CallID 10 First Buf Play at 01:00:44.580 of

flash:enter_account.au

01:00:44:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:44:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:44:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=1

01:00:44:CallID 10 Play Stopped at 01:00:44.928

01:00:45:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:45:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:45:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=1

01:00:45:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:45:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:45:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=1

01:00:45:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:45:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:45:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=#

01:00:45:pcapp CallID 10 returning PCAPP_MATCHED. string=111

01:00:45:cid( 10) running state get_pin

01:00:45:ta_PromptCmd. CallID=10

01:00:45:pcapp CallID 10 got event CC_EV_CALL_HANDOFF

01:00:45:prompt and collect app got callID 10

01:00:45:    Playing prompt flash:enter_pin.au

01:00:45:    Prompt interrupt enabled

01:00:45:    No return on play complete

01:00:45:    Not matching against dial plan

01:00:45:    Abort key is *    Termination key is #

01:00:45:    Matching against 1 patterns.

01:00:45:        Pattern .+

01:00:45:CallID 10 First Buf Play at 01:00:45.356 of flash:enter_pin.au

01:00:48:CallID 10 Play Stopped at 01:00:48.920

01:00:50:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:50:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:50:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=2

01:00:50:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:50:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:50:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=2

01:00:50:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:50:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:50:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=2

01:00:51:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:51:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:51:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=#

01:00:51:pcapp CallID 10 returning PCAPP_MATCHED. string=222

01:00:51:cid( 10) running state authenticate

01:00:51:authenticate

01:00:51:    account=111

01:00:51:    password=222

01:00:51:cid( 10) running state authen_pass

01:00:51:cid( 10) running state get_dest

01:00:51:ta_PromptCmd. CallID=10

01:00:51:pcapp CallID 10 got event CC_EV_CALL_HANDOFF

01:00:51:prompt and collect app got callID 10

01:00:51:    Playing prompt flash:enter_destination.au

01:00:51:    Prompt interrupt enabled

01:00:51:    No return on play complete

01:00:51:    Matching against dial plan

01:00:51:    Abort key is *    Termination key is #

01:00:51:    Matching against 0 patterns.

01:00:51:CallID 10 First Buf Play at 01:00:51.040 of

flash:enter_destination.au

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:55:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=4

01:00:55:CallID 10 Play Stopped at 01:00:55.468

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:55:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=0

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:55:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=8

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:55:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:55:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=5

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:56:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=2

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:56:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=1

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:56:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=0

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:56:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=4

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:56:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=0

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT_BEGIN

01:00:56:pcapp CallID 10 event CC_EV_CALL_DIGIT_BEGIN ignored

01:00:56:pcapp CallID 10 got event CC_EV_CALL_DIGIT digit=8

01:00:56:pcapp CallID 10 returning PCAPP_MATCHED. string=4085550408

01:00:56:cid( 10) running state place_call

01:00:56:Placing call for callID 10 to destination=4085550408

01:00:56:placecall CallID 10 got event CC_EV_CALL_HANDOFF

01:00:56:placecall pc_setupPeer cid(10), destPat(4085550408),

matched(10), prefix(), peer(617BB5AC)

01:00:56:pcSettlementAuthorize:authorizing for callid=10 using

calling=4085550502, called=4085550408

01:00:56:pcSettlementAuthorize:sending authorize request type=1,

args=0x619B50D8, sct=0x619B62DC

01:00:56:placecall cid(10) state change PC_CS_INIT to

PC_CS_CALL_SETTLING

01:00:57:pcSettlementSetup:settlement_curr_dest=0, num_dest=1

01:00:57:pcSettlementGetDestination:callinfop=0x619B61A0, error=0,

credit_time=20

01:00:57:pcSettlementSetup:placing call through ip(129.5.21.1),

calling(4085550502), called(4085550408), digits(4085550408)

01:00:57:placecall cid(10) state change PC_CS_CALL_SETTLING to

PC_CS_CALL_SETTING

01:00:57:placecall CallID 11 got event CC_EV_CALL_ALERT

01:00:57:placecall cid(10) state change PC_CS_CALL_SETTING to

PC_CS_CONFERENCING_ALERT

01:00:57:placecall CallID 10 got event CC_EV_CONF_CREATE_DONE

01:00:57:placecall cid(10) state change PC_CS_CONFERENCING_ALERT to

PC_CS_CONFERENCED_ALERT

01:01:00:placecall CallID 11 got event CC_EV_CALL_CONNECTED

01:01:00:placecall CallID 10 returning PLACECALL_ACTIVE.

01:01:00:pCall(0x619A63EC), settlement_credit_time=20

01:01:00:cid( 10) running state active

01:01:00:Wait for 10 seconds

01:01:06:Wait for 3 secondsMedia Content:flash:beep.au

  URL:flash:beep.au

  fd=-1, sampleRate=8000, bitsPerSample=8, coding=5, dataLength=1901,

  numReaders=0, writePtr=0, bufSize=1905, refCount=1

01:01:09:mallocing 1905

01:01:09:Only read 1901 bytes

01:01:09:pcapp CallID 10 got event CC_EV_CALL_HANDOFF

01:01:09:prompt and collect app got callID 10

01:01:09:    Playing prompt flash:beep.au

01:01:09:    Prompt interrupt disabled

01:01:09:    Return on play complete

01:01:09:    Not matching against dial plan

01:01:09:    No abort key

01:01:09:    No termination key

01:01:09:    Matching against 0 patterns.

01:01:09:CallID 10 First Buf Play at 01:01:09.732 of flash:beep.au

01:01:10:CallID 10 Play Stopped at 01:01:10.976

01:01:10:pcapp CallID 10 returning N/A. string=

01:01:10:Wait for 10 secondsMedia Content:flash:out_of_time.au

  URL:flash:out_of_time.au

  fd=-1, sampleRate=8000, bitsPerSample=8, coding=5, dataLength=8002,

  numReaders=0, writePtr=0, bufSize=8006, refCount=1

01:01:20:cid(10) conference_cleanup:ignoring event CC_EV_CALL_DIGIT

01:01:20:cid( 10) running state out_of_time

01:01:20:ta_PromptCmd. CallID=10

01:01:20:mallocing 8006

01:01:20:Only read 8002 bytes

01:01:20:pcapp CallID 10 got event CC_EV_CALL_HANDOFF

01:01:20:prompt and collect app got callID 10

01:01:20:    Playing prompt flash:out_of_time.au

01:01:20:    Prompt interrupt disabled

01:01:20:    Return on play complete

01:01:20:    Not matching against dial plan

01:01:20:    No abort key

01:01:20:    No termination key

01:01:20:    Matching against 0 patterns.

01:01:20:CallID 10 First Buf Play at 01:01:20.996 of

flash:out_of_time.au

01:01:23:CallID 10 Play Stopped at 01:01:23.020

01:01:23:pcapp CallID 10 returning N/A. string=

01:01:23:TCL script eval for callID 10 completed. code=OK

The following examples are from the code for Cisco IOS Release 12.1(3)T. The output is displayed when the debug voip ivr command is entered.

The following output is displayed when the debug voip ivr applib command is entered:

Router# debug voip ivr applib

ivr:

 ivr app library debugging is on

Router#

Jan 10 17:42:04.180:AppManagerCCAPI_Interface:

Jan 10 17:42:04.180:AppNewLeg

Jan 10 17:42:04.180:AppPushLegORConnection:Pushing LEG[34   ][NULL

] Onto {HAN[TCL_HAND][NULL  ]   ( )}

Jan 10 17:42:04.180:Event CC_EV_CALL_SETUP_IND[29]:LEG[34

][TCL_HAND]

Jan 10 17:42:04.184:AppPushHandler:Pushing {HAN[DC_HAND ][NULL  ]

( )} Onto {HAN[TCL_HAND][NULL  ]   ( LEG[34   ][TCL_HAND] )}

Jan 10 17:42:04.184:AppPushLegORConnection:Pushing LEG[34

][TCL_HAND] Onto {HAN[DC_HAND ][TCL_HAND]   ( )}

Jan 10 17:42:04.184:$ mediaPlay():CallID 34

Jan 10 17:42:04.184:Event CC_EV_CALL_REPORT_DIGITS_DONE[45]:LEG[34

][DC_HAND ]

Jan 10 17:42:17.261:AppMediaCallback:CallID 34 received

           response 'MSW_RESPONSE_TYPE_PLAY'

           with reason 'MSW_REASON_GENERIC_SUCCESS'

Jan 10 17:42:17.261:Event APP_EV_MEDIA_CALLBACK[47]:LEG[34

][DC_HAND ]

Jan 10 17:42:18.209:%ISDN-6-DISCONNECT:Interface Serial0:0

disconnected from unknown , call lasted 13 seconds

The following output is displayed when the debug voip ivr callsetup command is entered:

Router# debug voip ivr callsetup

Jan 10 17:45:57.528:%SYS-5-CONFIG_I:Configured from console by lab on

console

Jan 10 17:46:37.682:InitiateCallSetup:Incoming[66] AlertTime -1

Destinations(1) [ 3450070 ]

Jan 10 17:46:37.682:DNInitiate:Destination[3450070]

Jan 10 17:46:37.682:DNSetupPeer:

Jan 10 17:46:37.682:Destination SetupPeer cid(66), destPat(3450070),

match(2), prefix(), peer(61CB5CAC)

Jan 10 17:46:37.762:DNHandler:

(DN_SETTING[1])--(CC_EV_CALL_ALERT[11])--IGNORED-->>(DN_SETTING[1])

Jan 10 17:46:37.762:CS_Setting_ALERT:

Jan 10 17:46:37.762:CSPopLegAndWait:

Jan 10 17:46:37.762:CallSetupHandler:

 (CS_SETTING[0]) -----(CS_EV_ALERT[0])------->>>(CS_CONFINGALERT[4])

Jan 10 17:46:37.762:CS_ConfingAlert_CREATEDONE:

Jan 10 17:46:37.762:CallSetupHandler:

 (CS_CONFINGALERT[4])

-----(CS_EV_CREATEDONE[4])------->>>(CS_CONFEDALERT[5])

Jan 10 17:46:37.762:CallSetupHandler:

 (CS_CONFEDALERT[5])--(DN_SETTING[APP_EV_NULL])--IGNORED-->>>(CS_CONFEDALERT[5])

Router#

Jan 10 17:46:47.682:CallSetupHandler:

 (CS_CONFEDALERT[5])--(DN_SETTING[APP_EV_NULL])--IGNORED-->>>(CS_CONFEDALERT[5])

Jan 10 17:46:48.642:CS_ConfedAlert_CONNECTED:

Jan 10 17:46:48.642:CSDiscReturnAndEmptyLegALL:

Jan 10 17:46:48.642:DNCleanup:

Jan 10 17:46:48.642:DNSettlementCleanup:cid(66) trans=0, provider=0

Jan 10 17:46:48.642:CSReturnIFDone:CallSetup Returning(Status

CS_ACTIVE)

Jan 10 17:46:48.642:CallSetupHandler:

 (CS_CONFEDALERT[5]) -----(CS_EV_CONNECTED[1])------->>>(CS_CONFED[3])

Jan 10 17:46:48.646:CallSetupCleanup:

Router #

The following output is displayed when the debug voip ivr digitcollect command is entered:

Router# debug voip ivr digitcollect

ivr:

 ivr digit collect debugging is on

Router#

Router#

Router#

Jan 10 17:47:55.558:DigitCollect:DialPlan=FALSE AbortKey=* TermKey=#

NumPatts=1

       Enable=FALSE InterruptPrompt=TRUE maxDigits=11

Jan 10 17:47:55.558:act_DCRunning_RDone:callid=68 Enable succeeded.

Router#

Jan 10 17:48:04.006:DCHandlerFunc:PassingThrough

Jan 10 17:48:04.066:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:04.066:act_DCRunning_RDone:callid=68 Reporting disabled.

Jan 10 17:48:04.066:DigitCollectComplete:Status 5=DC_MATCHED_PATTERN.

Digits=1

Jan 10 17:48:04.070:DigitCollect:DialPlan=FALSE AbortKey=* TermKey=#

NumPatts=0

       Enable=FALSE InterruptPrompt=TRUE maxDigits=11

Jan 10 17:48:04.070:DCHandlerCleanup:

Jan 10 17:48:04.074:act_DCRunning_RDone:callid=68 Enable succeeded.

Router#

Router#

Jan 10 17:48:08.038:DCHandlerFunc:PassingThrough

Jan 10 17:48:09.246:DCHandlerFunc:PassingThrough

Jan 10 17:48:09.286:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:09.478:DCHandlerFunc:PassingThrough

Jan 10 17:48:09.506:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:10.739:DCHandlerFunc:PassingThrough

Jan 10 17:48:10.779:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:11.027:DCHandlerFunc:PassingThrough

Jan 10 17:48:11.067:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:11.687:DCHandlerFunc:PassingThrough

Jan 10 17:48:11.747:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:12.219:DCHandlerFunc:PassingThrough

Jan 10 17:48:12.279:act_DCRunning_Digit::pLeg 68 Digit 2

Jan 10 17:48:14.227:DCHandlerFunc:PassingThrough

Jan 10 17:48:14.287:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:14.779:DCHandlerFunc:PassingThrough

Jan 10 17:48:14.859:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:15.307:DCHandlerFunc:PassingThrough

Jan 10 17:48:15.359:act_DCRunning_Digit::pLeg 68 Digit 1

Jan 10 17:48:15.719:DCHandlerFunc:PassingThrough

Jan 10 17:48:15.759:act_DCRunning_Digit::pLeg 68 Digit 2

Jan 10 17:48:16.219:DCHandlerFunc:PassingThrough

Jan 10 17:48:16.299:act_DCRunning_Digit::pLeg 68 Digit T

Jan 10 17:48:16.299:act_DCRunning_RDone:callid=68 Reporting disabled.

Jan 10 17:48:16.299:DigitCollectComplete:Status 5=DC_MATCHED_PATTERN.

Digits=1111121112

Jan 10 17:48:16.303:DCHandlerCleanup:

Jan 10 17:48:16.335:DigitCollect:DialPlan=TRUE AbortKey=* TermKey=#

NumPatts=0

       Enable=FALSE InterruptPrompt=TRUE maxDigits=0

Jan 10 17:48:16.339:act_DCRunning_RDone:callid=68 Enable succeeded.

Router # 

The following output is displayed when the debug voip ivr script command is entered:

Router# debug voip ivr script

ivr:

 ivr script debugging is on

Router#

Jan 10 17:49:10.250:FSM Transtion:([1

]CALL_INIT,[29]ev_setup_indication)---([10]act_Setup)--->([4

]LANGSELECTION)

Jan 10 17:49:10.250:TotalLanguages= 2

Router#

Router#

Jan 10 17:49:16.662:FSM Transtion:([4

]LANGSELECTION,[55]ev_digitcollect_done)---([1 ]act_LangSelect)--->([5

]CARDSELECTION)

Router#

Router#

Jan 10 17:49:20.630:([5 ]CARDSELECT,[47]ev_media_d) ------> NOTHANDLED

Jan 10 17:49:26.770:FSM Transtion:([5

]CARDSELECTION,[55]ev_digitcollect_done)---([2

]act_GotCardNumber)--->([6 ]AUTHORIZE)

Jan 10 17:49:26.806:FSM Transtion:([6

]AUTHORIZE,[49]ev_authorize_done)---([8 ]act_FirstAuthorized)--->([7

]GETDEST)

Jan 10 17:49:26.806: aaa authorize Status=ao_000

Router#

Router#

Router#

Jan 10 17:49:33.395:([7 ]GETDEST  ,[47]ev_media_d) ------> NOTHANDLED

Jan 10 17:49:36.411:FSM Transtion:([7

]GETDEST,[55]ev_digitcollect_done)---([3 ]act_GotDest)--->([8

]SECONDAUTHORIZE)

Jan 10 17:49:36.451:FSM Transtion:([8

]SECONDAUTHORIZE,[49]ev_authorize_done)---([5

]act_SecondAuthorized)--->([10]PLACECALL)

Jan 10 17:49:36.451: aaa authorize Status=ao_000

Jan 10 17:49:42.179:FSM Transtion:

([10]PLACECALL,[47]ev_media_done)---([9

]act_CallSetup)--->([10]PLACECALL)

The following output is displayed when the debug voip ivr tclcommands command is entered:

Router# debug voip ivr tclcommands

ivr tcl commands debugging is on

Router#

Jan 10 17:50:29.106:tcl_infotagCmd:infotag get leg_ani

Jan 10 17:50:29.106:tcl_getInfoCmd:get leg_ani

Jan 10 17:50:29.106:vtr_ci_incani:argc 2 argindex 2

Jan 10 17:50:29.106:tcl_infotagCmd:infotag set med_language 1

Jan 10 17:50:29.106:tcl_setInfoCmd:set med_language 1

Jan 10 17:50:29.106:vtw_ms_language:

Jan 10 17:50:29.106:tcl_legCmd:leg setupack leg_incoming

Jan 10 17:50:29.106:tcl_setupAckCmd:setupack leg_incoming

Jan 10 17:50:29.106:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:29.106:tcl_legCmd:leg proceeding leg_incoming

Jan 10 17:50:29.106:tcl_callProceedingCmd:proceeding leg_incoming

Jan 10 17:50:29.106:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:29.110:tcl_legCmd:leg connect leg_incoming

Jan 10 17:50:29.110:tcl_callConnectCmd:connect leg_incoming

Jan 10 17:50:29.110:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:29.110:tcl_legCmd:leg collectdigits leg_incoming param1

patterns

Jan 10 17:50:29.110:tcl_collectDigitsCmd:collectdigits leg_incoming

param1 patterns

Jan 10 17:50:29.110:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:29.110:tcl_mediaCmd:media play leg_incoming _welcome.au

%s1000 %c1 _lang_sel1.au %s1000 %c2 _lang_sel2.au

Jan 10 17:50:29.110:tcl_mediaPlayCmd:play leg_incoming _welcome.au

%s1000 %c1 _lang_sel1.au %s1000 %c2 _lang_sel2.au

Jan 10 17:50:29.110:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Router#

Router#

Jan 10 17:50:35.506:tcl_infotagCmd:infotag get evt_status

Jan 10 17:50:35.506:tcl_getInfoCmd:get evt_status

Jan 10 17:50:35.506:vtr_ev_status:

Jan 10 17:50:35.510:tcl_infotagCmd:infotag get evt_dcdigits

Jan 10 17:50:35.510:tcl_getInfoCmd:get evt_dcdigits

Jan 10 17:50:35.510:vtr_ev_dcdigits:

Jan 10 17:50:35.510:DCDIGITS [1]

Jan 10 17:50:35.510:tcl_infotagCmd:infotag set med_language 1

Jan 10 17:50:35.510:tcl_setInfoCmd:set med_language 1

Jan 10 17:50:35.510:vtw_ms_language:

Jan 10 17:50:35.510:tcl_legCmd:leg collectdigits leg_incoming param1

Jan 10 17:50:35.510:tcl_collectDigitsCmd:collectdigits leg_incoming

param1

Jan 10 17:50:35.510:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:35.510:tcl_mediaCmd:media play leg_incoming

_enter_card_num.au

Jan 10 17:50:35.510:tcl_mediaPlayCmd:play leg_incoming

_enter_card_num.au

Jan 10 17:50:35.514:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Router#

Jan 10 17:50:43.878:tcl_infotagCmd:infotag get evt_status

Jan 10 17:50:43.878:tcl_getInfoCmd:get evt_status

Jan 10 17:50:43.878:vtr_ev_status:

Jan 10 17:50:43.882:tcl_infotagCmd:infotag get evt_dcdigits

Jan 10 17:50:43.882:tcl_getInfoCmd:get evt_dcdigits

Jan 10 17:50:43.882:vtr_ev_dcdigits:

Jan 10 17:50:43.882:DCDIGITS [1111121112]

Jan 10 17:50:43.882:tcl_aaaCmd:aaa authorize 111112 1112 50073

leg_incoming

Jan 10 17:50:43.882:tcl_AuthorizeCmd:authorize 111112 1112 50073

leg_incoming

Jan 10 17:50:43.882:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:43.882:Authorize

Jan 10 17:50:43.882:  account=111112

Jan 10 17:50:43.882:  password=1112

Jan 10 17:50:43.882:  ani   =50073

Jan 10 17:50:43.882:  dnis  =

Jan 10 17:50:43.910:tcl_infotagCmd:infotag get evt_status

Jan 10 17:50:43.910:tcl_getInfoCmd:get evt_status

Jan 10 17:50:43.910:vtr_ev_status:

Jan 10 17:50:43.914:tcl_infotagCmd:infotag get aaa_avpair_exists

creditAmount

Jan 10 17:50:43.914:tcl_getInfoCmd:get aaa_avpair_exists creditAmount

Jan 10 17:50:43.914:vtr_ra_avpair_exists:

Jan 10 17:50:43.914:tcl_infotagCmd:infotag get aaa_avpair creditAmount

Jan 10 17:50:43.914:tcl_getInfoCmd:get aaa_avpair creditAmount

Jan 10 17:50:43.914:vtr_ra_avpair:

Jan 10 17:50:43.914:tcl_legCmd:leg collectdigits leg_incoming param2

Jan 10 17:50:43.914:tcl_collectDigitsCmd:collectdigits leg_incoming

param2

Jan 10 17:50:43.914:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

Jan 10 17:50:43.914:tcl_mediaCmd:media play leg_incoming _you_have.au

%a1000 %s1000 _enter_dest.au

Jan 10 17:50:43.914:tcl_mediaPlayCmd:play leg_incoming _you_have.au

%a1000 %s1000 _enter_dest.au

Jan 10 17:50:43.918:vtd_lg_incoming:Legs [71 ]VARTAG Translation Leg

Count=1

rtsp client session history duration

To specify how long to keep Real Time Streaming Protocol (RTSP) client session history records in memory, use the rtsp client session history duration command in global configuration mode. To set the value to the default, use the no form of this command.

rtsp client session history duration number

no rtsp client session history duration number

Syntax Description

number

Specifies how long, in minutes, to keep the record. The range is from 1 to 10,000. The default is 10 minutes.

Defaults

10 minutes

Command Modes

Global configuration

Command History

Release	Modification
12.1(3)T	This command was introduced.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Examples

The following example sets the duration for the RTSP session history to 500 minutes:

rtsp client session history duration 500 

Related Commands

Command	Description
call application voice load	Allows reload of an application that was loaded via the MGCP scripting package.
rtsp client session history records	Specifies the number of RTSP client session history records kept during the session.
show call application voice	Displays all TCL or MGCP scripts that are loaded.
show rtsp client session	Displays cumulative information about the RTSP session records.

rtsp client session history records

To configure the number of records to keep in the Real Time Streaming Protocol (RTSP) client session history, use the rtsp client session history records command in global configuration mode. To set the value to the default, use the no form of this command.

rtsp client session history records number

no rtsp client session history records number

Syntax Description

number

Number of records to retain in a session history. Values range from 1 to 100,000. The default is 50 records.

Defaults

50 records

Command Modes

Global configuration

Command History

Release	Modification
12.1(3)T	This command was introduced.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Examples

The following example configures a total of 500 records to keep in the RTSP client history:

rtsp client session history records 500

Related Commands

Command	Description
call application voice load	Allows reload of an application that was loaded via the MGCP scripting package.
rtsp client session history duration	Specifies how long to keep RTSP session history records in memory.
show call application voice	Displays all TCL or MGCP scripts that are loaded.

session protocol

To specify a session protocol for calls between the local and remote routers using the packet network, use the session protocol command in dial-peer configuration mode. To reset the default value for this command, use the no form of this command.

session protocol {cisco | sipv2 | aal2-trunk | smtp}

no session protocol

Syntax Description

cisco	Configures the dial peer to use the proprietary Cisco Voice over IP (VoIP) session protocol.
sipv2	Configures the VoIP dial peer to use IETF session initiation protocol (SIP). SIP users should use this option.
aal2-trunk	Configures the dial peer to use ATM adaptation layer 2 (AAL2) nonswitched trunk session protocol.
smtp	Specifies the Simple Mail Transfer Protocol (SMTP) session protocol.

Defaults

No default behaviors or values.

Command Modes

Dial-peer configuration

Command History

Release	Modification
11.3(1)T	This command was introduced.
12.0(4)T	This command was modified for store-and-forward fax on the Cisco AS5300 universal access server.
12.1(1)T	The sipv2 keyword was added.
12.1(1)XA	Support was added for Voice over ATM (VoATM) dial peers on the Cisco MC3810 multiservice access concentrator with the aal2-trunk keyword.
12.1(2)T	This command was integrated into the Cisco IOS Release 12.1(2)T.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Usage Guidelines

The cisco keyword is applicable only to VoIP on the Cisco 3600 series and Cisco 1750 series routers. The aal2-trunk keyword is applicable only to VoATM on the Cisco MC3810 multiservice access concentrator.

This command applies to both on-ramp and off-ramp store-and-forward fax functions.

Examples

The following is an example of configuring a VoIP dial peer for H.323 or SIP as the session protocol for VoIP call signaling:

dial-peer voice 102 voip

 session protocol sipv2

The following example selects AAL2 trunking as the session protocol on a Cisco MC3810 multiservice concentrator:

dial-peer voice 10 voatm

 session protocol aal2-trunk

The following example selects Cisco Session Protocol as the session protocol on a Cisco 3600 series router:

dial-peer voice 20 voip

 session protocol cisco

The following example selects SMTP as the session protocol:

dial-peer voice 10 mmoip

 session protocol smtp

Related Commands

Command	Description
dial-peer voice	Enters dial-peer configuration mode and specifies the method of voice-related encapsulation.
session target (VoIP)	Configures a network-specific address for a dial peer.

show call application voice

To display the names of the audio files that the interactive voice response (IVR) script will play, the operation of the abort keys, the prompts that are used, and caller interaction, use the show call application voice command in EXEC mode.

show call application voice [application-name | summary]

Syntax Description

application-name	(Optional) Name of the desired IVR application.
summary	(Optional) Displays a one-line summary. If the command is entered without the summary keyword, a complete detailed description is displayed of the application.

Defaults

No default behavior or values.

Command Modes

EXEC

Command History

Release	Modification
11.3(6)NA2	This command was introduced.
12.0(3)T	This command was integrated into Cisco IOS Release 12.0(3)T.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Usage Guidelines

If the name of a specific application is entered, detailed information about that application will be displayed.

If the summary keyword is entered, a one-line summary about each application will be displayed.

If the command is entered with neither the application name nor the summary keyword, detailed information about all applications will be displayed.

Examples

This example shows the output for the clid_authen_collect IVR script:

Router# show call application voice clid_authen_collect

Application clid_authen_collect has 10 states with 0 calls active

 State start has 1 actions and 5 events

    Do Action IVR_ACT_AUTHENTICATE. accountName=ani, pinName=dnis

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_CALL_SETUP_IND do action IVR_ACT_CALL_SETUP_ACK

          and goto state start

    If Event IVR_EV_AAA_SUCCESS goto state collect_dest

    If Event IVR_EV_AAA_FAIL goto state get_account

 State end has 1 actions and 3 events

    Do Action IVR_ACT_END.

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_CALL_DISCONNECT_DONE do action IVR_ACT_CALL_DESTROY

          and do nothing

State get_account has 4 actions and 7 events

    Do Action IVR_ACT_PLAY.

            URL: flash:enter_account.au

            allowInt=1, pContent=0x60E4C564

    Do Action IVR_ACT_ABORT_KEY. abortKey=*

    Do Action IVR_ACT_TERMINATION_KEY. terminationKey=#

    Do Action IVR_ACT_COLLECT_PATTERN. Pattern account is .+

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_PAT_COL_SUCCESS goto state get_pin

            patName=account

    If Event IVR_EV_ABORT goto state get_account

    If Event IVR_EV_PLAY_COMPLETE do nothing

    If Event IVR_EV_TIMEOUT goto state get_account count=0

    If Event IVR_EV_PAT_COL_FAIL goto state get_account

 State get_pin has 4 actions and 7 events

    Do Action IVR_ACT_PLAY.

            URL: flash:enter_pin.au

            allowInt=1, pContent=0x0

    Do Action IVR_ACT_ABORT_KEY. abortKey=*

    Do Action IVR_ACT_TERMINATION_KEY. terminationKey=#

    Do Action IVR_ACT_COLLECT_PATTERN. Pattern pin is .+

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_PAT_COL_SUCCESS goto state authenticate

            patName=pin

    If Event IVR_EV_PLAY_COMPLETE do nothing

    If Event IVR_EV_ABORT goto state get_account

    If Event IVR_EV_TIMEOUT goto state get_pin count=0

    If Event IVR_EV_PAT_COL_FAIL goto state get_pin

 State authenticate has 1 actions and 5 events

    Do Action IVR_ACT_AUTHENTICATE. accountName=account, pinName=pin

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_AAA_SUCCESS goto state collect_dest

    If Event IVR_EV_TIMEOUT do nothing count=0

    If Event IVR_EV_AAA_FAIL goto state authenticate_fail

 State collect_dest has 4 actions and 8 events

    Do Action IVR_ACT_PLAY.

            URL: flash:enter_destination.au

            allowInt=1, pContent=0x0

    Do Action IVR_ACT_ABORT_KEY. abortKey=*

    Do Action IVR_ACT_TERMINATION_KEY. terminationKey=#

    Do Action IVR_ACT_COLLECT_DIALPLAN.

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_PLAY_COMPLETE do nothing

    If Event IVR_EV_ABORT goto state collect_dest

    If Event IVR_EV_TIMEOUT goto state collect_dest count=0

    If Event IVR_EV_DIAL_COL_SUCCESS goto state place_call

    If Event IVR_EV_DIAL_COL_FAIL goto state collect_dest

    If Event IVR_EV_TIMEOUT goto state collect_dest count=0

 State place_call has 1 actions and 4 events

    Do Action IVR_ACT_PLACE_CALL.

            destination= called=

            calling=      account=

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

    If Event IVR_EV_CALL_UP goto state active

    If Event IVR_EV_CALL_FAIL goto state place_fail

 State active has 0 actions and 2 events

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

 State authenticate_fail has 1 actions and 2 events

    Do Action IVR_ACT_PLAY.

            URL: flash:auth_failed.au

            allowInt=0, pContent=0x0

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

 State place_fail has 1 actions and 2 events

    Do Action IVR_ACT_PLAY_FAILURE_TONE.

    If Event IVR_EV_DEFAULT goto state end

    If Event IVR_EV_CALL_DIGIT do nothing

This example shows the output for the summary keyword:

Router# show call application voice summary

name                 description

session              Basic app to do DID, or supply dialtone.

fax_hop_on           Script to talk to a fax redialer

clid_authen          Authenticate with (ani, dnis)

clid_authen_collect  Authenticate with (ani, dnis), collect if that fails

clid_authen_npw      Authenticate with (ani, NULL)

clid_authen_col_npw  Authenticate with (ani, NULL), collect if that fails

clid_col_npw_3       Authenticate with (ani, NULL), and 3 tries collecting

clid_col_npw_npw     Authenticate with (ani, NULL) and 3 tries without pw

DEFAULT              Default system session application

lib_off_app          Libretto Offramp

TCL Script Version 2.0 supported.

TCL Script Version 1.1 supported.

Voice Browser Version 1.0 for VoiceXML 1.0 supported.

Related Commands

Command	Description
call application voice	Defines 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.

show rtsp client session

To display cumulative information about Real Time Streaming Protocol (RTSP) session records, use the show rtsp client session command in privileged EXEC mode.

show rtsp client session {history | active} [detailed]

Syntax Description

history	Displays cumulative information about the session, packet statistics, and general call information such as call ID, session ID, individual RTSP stream URLs, packet statistics, and play duration.
active	Displays the session information and stream information for the stream that is currently active.
detailed	(Optional) Displays the session information and stream information in detail for all streams that are associated with the session.

Defaults

Active (current) stream information is displayed.

Command Modes

Privileged EXEC

Command History

Release	Modification
12.1(3)T	This command was introduced.
12.1(5)T	This command was implemented on the Cisco AS5800 universal access server.
12.1(5)XM2	This command was implemented on the Cisco AS5350 and Cisco AS5400 universal gateways.
12.2(2)XB1	This command was implemented on the Cisco AS5850 universal gateway.
12.2(4)XM	This command was implemented on the Cisco 1750 and Cisco 1751 platforms. This release does not support any other Cisco platforms.

Usage Guidelines

Use this command to display cumulative information about the session, packet statistics, and general call information such as call ID and session ID.

---

Note Session refers to a session between the application and the RTSP client. Each call leg that is configured to use RTSP streaming has a session.

---

A call leg could play several prompts in a session; the "Play Time" refers to the play time associated with a stream or, in other words, a prompt; the cumulative play time is the sum total of all streams (or prompts) played out in a session.

The command output is a stream block that contains information about the stream (URL, packet statistics, current state of the stream, play duration, call ID, session ID, individual RTSP stream URLs, and packet statistics).

Examples

The following output is displayed when the show rtsp client session active command is used during an active session:

Router# show rtsp client session active

RTSP Session ID:0x8     Current Status:RTSP_STATUS_PLAYING

Associated CallID:0xF

Active Request:RTSP_API_REQ_PLAY

Control Protocol:TCP     Data Protocol:RTP

Total Packets Transmitted:0 (0 bytes)

Total Packets Received:708 (226560 bytes)

Cumulative Elapsed Play   Time:00:00:28.296

Cumulative Elapsed Record Time:00:00:00.000

        Session ID:0x8     State:ACTIVE

        Local  IP Address:1.13.79.45     Local  Port 16660

        Server IP Address:1.13.79.6     Server Port 11046

        Stream URL:rtsp://rtsp-cisco.cisco.com:554/chinna.au/streamid=0

        Packets Transmitted:0 (0 bytes)

        Packets Received:708 (226560 bytes)

        Elapsed Play   Time:00:00:28.296

        Elapsed  Record Time:00:00:00.000

        ReceiveDelay:85     LostPackets:0

The following output is displayed when the show rtsp client session history detailed command is used:

Router# show rtsp client session history detailed

RTSP Session ID:0x8

Associated CallID:0xF

Control Protocol:TCP     Data Protocol:RTP

Total Packets Transmitted:0 (0 bytes)

Total Packets Received:2398 (767360 bytes)

Cumulative Elapsed Play   Time:00:01:35.916

Cumulative Elapsed Record Time:00:00:00.000

        Session ID:0x8     State:INACTIVE

        Local  IP Address:1.13.79.45     Local  Port 16660

        Server IP Address:1.13.79.6     Server Port 11046

        Stream URL:rtsp://rtsp-cisco.cisco.com:554/chinna.au/streamid=0

        Packets Transmitted:0 (0 bytes)

        Packets Received:2398 (767360 bytes)

        Play   Time:00:01:35.916

        Record Time:00:00:00.000

        OntimeRcvPlayout:93650

        GapFillWithSilence:0

        GapFillWithPrediction:70

        GapFillWithInterpolation:0

        GapFillWithRedundancy:0

        HighWaterPlayoutDelay:85

        LoWaterPlayoutDelay:64

        ReceiveDelay:85     LostPackets:0

        EarlyPackets:2     LatePackets:12

Related Commands

Command	Description
rtsp client session history duration	Specifies how long to keep RTSP client session history records in memory.
rtsp client session history records	Configures the number of records to keep in the RTSP client session history.

Glossary

CA—call agent. Intelligent entity in an IP telephony network that handles call control in an MGCP model Voice over IP network. Also known as a media gateway controller (MGC).

DNIS—dialed number identification service (the called number). Feature of trunk lines in which the called number is identified; this called number information is used to route the call to the appropriate service. DNIS is a service used with toll-free dedicated services whereby calls placed to specific toll-free numbers are routed to the appropriate area within a company to be answered.

ISP—Internet service provider. Company that provides Internet access to other companies and individuals.

IVR—interactive voice response. Term used to describe systems that provide information in the form of recorded messages over telephone lines in response to user input in the form of spoken words or, more commonly, DTMF signaling. Examples include banks that allow you to check your balance from any telephone and automated stock quote systems.

media stream—A single media instance. For example, an audio stream.

MGC—media gateway controller. The emerging industry standard generic term for the VSC.

MGCP—Media Gateway Control Protocol. A merging of the IPDC and SGCP protocols.

PSTN—Public Switched Telephony Network. General term that refers to the variety of telephone networks and services in place worldwide. Sometimes called POTS.

RTP—Real Time Protocol. A protocol used to transport real-time frames over a UDP network.

RTSP—Real Time Streaming Protocol. Enables the controlled delivery of real-time data, such as audio and video. Sources of data can include both live data feeds, such as live audio and video, and stored content, such as prerecorded events. RTSP is designed to work with established protocols, such as RTP and HTTP.

RTSP session—"Session" refers to a session between the application and the RTSP client. Each call leg that is configured to use RTSP streaming has a session.

TCL—Tool Command Language. A scripting language used for gateway products both internally and externally to Cisco IOS software code.

VoFR—Voice over Frame Relay. VoFR enables a router to carry voice traffic (for example, telephone calls and faxes) over a Frame Relay network. When sending voice traffic over Frame Relay, the voice traffic is segmented and encapsulated for transit across the Frame Relay network using FRF.12 encapsulation.

VoIP—Voice over IP. The capability to carry normal telephony-style voice over an IP-based internet with POTS-like functionality, reliability, and voice quality. VoIP enables a router to carry voice traffic (for example, telephone calls and faxes) over an IP network. In VoIP, the DSP segments the voice signal into frames, which then are coupled in groups of two and stored in voice packets. These voice packets are transported using IP in compliance with ITU-T specification H.323.

VSC—Cisco's virtual switch controller.