|
|
This document provides the additional information you need to configure T.38 fax relay and T.37 fax store and forward on a voice feature card installed in a Cisco AS5300 access server. The Store and Forward Fax feature, previously documented in other Cisco publications, enables Cisco AS5300 access servers to send and receive faxes across packet-based networks.
This document includes the following sections:
Previously, store and forward fax was supported only on MICA and Microcom modem cards. Voice applications run on the C542 Digital Signal Processing Module (DSPM) and C549 DSPMs that populate a Cisco AS5300 voice feature card (VFC). Equipping a Cisco AS5300 with both store and forward fax and voice is inefficient because of the need to use different technologies for each type of call.
The objective of this software release is to allow a single DSPM technology to support voice, fax relay, and fax store and forward on both the C542 and C549 DSPM. A further objective is to offer voice, fax relay, and fax store and forward on the same voice port, and to provide the ability to dynamically switch from one application to another in the same call (IVR, voice, fax relay, and fax store and forward).
A related objective is to migrate from the current Cisco proprietary implementation of real-time fax relay to the ITU-T T.38 standard. The proposed implementation on the C54x DSPM is for the ingress DSP to perform real-time fax relay to the router processor.
 |
Note In order to support the maximum of 120 fax store and forward sessions, the Cisco AS5300 must be equipped with 128 MB of RAM. |
The diagram below highlights the real-time versus the store and forward processing path for a fax transaction over an IP network.
The T.38 path represents the real-time fax relay connection between two VOIP gateways. The current fax relay implementation in VOIP uses a proprietary protocol over an H.323 connection. This software release will allow the standard T.38 fax implementation to take preference over the Cisco proprietary protocol where possible. This means that as a fax session is being set up and negotiated over the H.323 connection, the sending gateway will attempt to communicate via the T.38 protocol first and then attempt the Cisco proprietary protocol if the first method is rejected.
The T.37 path represents the processing path for a fax that is delivered via the ESMTP store and forward method. The onramp fax gateway is responsible for accepting fax data from the PSTN fax machine using this software release and the VFC acting as a fax modem. The gateway router processor converts the fax into a TIFF attachment in a MIME e-mail message and transmits it to a store and forward SMTP server. Delivery of the faxmail message to the offramp gateway is the responsibility of the store and forward server(s). Once the offramp gateway receives a faxmail message, it will process the message and initiate a fax session with the destination fax machine using this software release and the VFC acting as a fax modem.
The Interactive Voice Response (IVR) feature is used for call control when VFCs are used for store and forward fax. 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 based on DNIS. An IP PSTN gateway can have several different IVR applications to accommodate many different gateway services, and you can customize the IVR applications to present different interfaces to the different callers.
IVR uses Tool Control Language (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 PIN. After playing the voice prompt, the IVR application collects the predetermined number of touch tones (digit collection) and forwards the collected digits to a server for storage and retrieval. Call records can be kept and a variety of accounting functions performed.
|
Note All IVR scripts are modified and secured with a proprietary Cisco locking mechanism. Only Cisco internal technical support personnel can open and modify these scripts. |
Cisco provides the following IVR scripts:
Table 1 lists the prompt audio files associated with the clid_col_npw_3 script.
| Audio File Name | Action |
|---|---|
flash:enter_account.au | Asks the caller to enter an account number the first time. |
flash:auth_fail_retry.au | Played after two failures, asks the caller to reenter the account number. |
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 authorization failed three times. |
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." |
|
Note To see the contents of the TCL IVR script, use the show call application voice command. |
The following IVR script is not built into Cisco IOS software but is required for T.37 on-ramp applications using a VFC. You must download this script manually:
Cost Savings and Port Density
Rather than bearing the cost of maintaining two architectures, one for voice and one for fax, service providers can use a single port for both voice, fax relay, and store and forward fax. For smaller POPs, the ability to use a single port for both technologies is even more significant due to greater efficiencies of handling mixed traffic over a single pool of ports versus splitting traffic across two pools (whose combined total number of ports would exceed the number in the mixed traffic case).
Single Number for Voice and Fax Access
Service providers can advertise new service offerings such as a single number for subscriber voice and fax access. Service provider applications that use a single number for voice and fax require only half as many DNIS numbers and dial peers as would be required with separate voice and fax applications.
Switch from Fax Relay to Fax Store and Forward
Service providers can offer applications that require toggling from voice to fax - for example, providing an IVR front-end to a fax application. Also applications such as never-busy fax service can be addressed once the gateway has the ability to dynamically switch from fax relay to fax store and forward.
|
Note In order to support the maximum of 120 fax store and forward sessions, the Cisco AS5300 must be equipped with 128 MB of RAM. |
For related information on this feature, refer to the following documents:
Standards
MIBs
See the Store and Forward Fax with ESMTP document.
For descriptions of supported MIBs and how to use MIBs, see the Cisco MIB web site on CCO at http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml.
RFCs
See the Store and Forward Fax with ESMTP document.
Before configuring T.38 fax relay and T.37 store and forward fax on a Cisco AS5300 VFC, you must complete the following tasks:
These tasks are described in the sections below.
VFCs for the Cisco AS5300 come with a single bundled image of VCWare stored in VFC Flash memory. Table 2 shows the extension types defined for these embedded firmware files.
| Firmware | Filenames | Description |
|---|---|---|
VCWare | vcw-vfc-* | Latest version of VCWare stores in Flash memory, including:
|
DSPWare | btl-vfc-* | DSP bootloader |
| cor-vfc-* | Core operating system and initialization |
| bas-vfc-* | Base voice |
| cdc-*-* | Voice codec files |
| fax-vfc-* | Fax relay files |
DSPWare is stored as a compressed file within VCWare; you must unbundle VCWare to install DSPWare into Flash memory. During the unbundling process, two default lists (the default file list and the capability list) are automatically created, populated with default files from that version of VCWare, and stored in VFC Flash memory. The default file list contains the filenames indicating which files are initially loaded into DSP upon bootup. The capability list defines the set of codecs that can be negotiated for a voice call.
VFC management enables you to add versions of VCWare to Flash memory (download and unbundle files), erase files contained in Flash memory, add files to the default file list and capability list, and delete files from the default file lists and capability lists. These tasks are described in the following sections:
To download software to your VFC, perform the following tasks:
To determine the number of installed VFCs and their location, use the following command in privileged EXEC mode:
| Command | Purpose |
|---|---|
Router# show vfc slot directory | Determines the number of installed VFCs and their location. |
For each VFC identified and located, perform the tasks described in the following sections to upgrade system software on that VFC.
To identify the mode (whether VCWare or ROM Monitor), use the following commands in privileged EXEC mode:
| Command | Purpose |
|---|---|
Router# show vfc slot board | Determines whether your VFC is operating in VCWare mode or ROM Monitor mode. |
If the mode is VCWare, the VFC status will be "VCWARE running." If the mode is ROM Monitor, the VFC status will be "ROMMON."
To download VFC software to the VFC while the VFC is in VCWare mode, use the following commands beginning in privileged EXEC mode:
| Command | Purpose | |||||
|---|---|---|---|---|---|---|
Step 1 | Router# erase vfc slot | Erases the Flash memory. | ||||
Step 2 | Router# show vfc slot directory | Verifies that the VFC Flash memory is indeed empty. | ||||
Step 3 | Router# copy tftp: vfc: | Downloads the VCWare from a TFTPBoot server into VFC Flash memory.
Downloads the VCWare from the VFC motherboard into VFC Flash memory.
| ||||
Step 4 | Router# clear vfc slot | Reboots the VFC. | ||||
Step 5 | Router# show vfc slot board | Checks whether the VFC is back up in VCWare mode. | ||||
Step 6 | Router# show vfc slot directory | Verifies that VCWare is in the VFC Flash. | ||||
Step 7 | Router# unbundle vfc slot | Unbundles the DSPWare from the VCWare and configures the default file list and the capability list. | ||||
Step 8 | Router# show vfc slot directory | Verifies that the DSPWare has been unbundled. | ||||
Step 9 | Router# show vfc slot default-list | Verifies that the default file list has been populated. | ||||
Step 10 | Router# show vfc slot cap-list | Verifies that the capability list has been populated. |
After you have completed the preceding tasks, reboot the Cisco AS5300 for these changes to take effect.
|
Note If the VFC ROM is version 1.1, the image name must end in ".VCW." If the VFC ROM is version 1.2, the image name must start with "vcv-." |
|
Note In any copy command in which "vfc" is the target, it is imperative that you include a colon after the "vfc." Thus, in Step 3 above and in Step 2 below, copy tftp vfc: must be the syntax. |
To download VFC software to the VFC while the VFC is in ROM Monitor mode, use the following commands beginning in privileged EXEC mode:
| Command | Purpose | |||||
|---|---|---|---|---|---|---|
Step 1 | Router# clear vfc slot purge | Erases the VFC Flash memory. | ||||
Step 2 | Router# copy tftp: vfc: | Downloads the VCWare from a TFTP server into VFC Flash memory.
or Downloads the VCWare from the VFC motherboard into VFC Flash memory.
| ||||
Step 3 | Router# clear vfc slot | Reboots the VFC. | ||||
Step 4 | Router# show vfc slot board | Checks whether the VFC is back up in VCWare mode. | ||||
Step 5 | Router# show vfc slot directory | Verifies that VCWare is in the VFC Flash. | ||||
Step 6 | Router# unbundle vfc slot | Unbundles the DSPWare from the VCWare and configures the default file list and the capability list. | ||||
Step 7 | Router# show vfc slot directory | Verifies that the DSPWare has been unbundled. | ||||
Step 8 | Router# show vfc slot default-list | Verifies that the default file list has been populated. | ||||
Step 9 | Router# show vfc slot cap-list | Verifies that the capability list has been populated. |
After you have completed the preceding tasks, reboot the Cisco AS5300 for these changes to take effect.
|
Note The image name must start with "vcw-." |
To download the VCWare file from the AS5300 motherboard to VFC Flash memory, use the following command in privileged EXEC mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router# copy flash vfc: | Downloads (copies) the Flash file from the AS5300 motherboard to the Flash memory on the VFC. (NOTE: Be sure to include the colon in this command.) |
Step 2 | Router# clear vfc slot | Reboots the VFC. |
To download the latest version of VCWare from a TFTP server, make sure that the file is stored on the TFTP server. If you have a copy of the current version of VCWare on disk, you must store that image on a TFTP server before you can download the file to VFC memory.
To copy the Flash file from a TFTP server, use the following command in privileged EXEC mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router# copy flash vfc: | Downloads (copies) the Flash file from a TFTP server to the Flash memory on the VFC. (NOTE: Be sure to include the colon in this command.) |
Step 2 | Router# clear vfc slot | Reboots the VFC. |
VCWare needs to be unbundled for DSPWare to be loaded in Flash memory and the two necessary default lists (default file list and capability list) created and populated with the appropriate default files for that version of DSPWare. Table 3 shows the files associated with each firmware file.
| Firmware | Filenames |
|---|---|
VCWare | vcw-vfc-mz.c542.t1.6 |
DSPWare Initialization and Static Files | btl-vfc-l.0.1.bin |
DSPWare Overlay Files | bas-vfc-hc-1.3.4.24l.bin |
To unbundle the current running image of VCWare, use the following command in privileged EXEC mode:
| Command | Purpose |
|---|---|
Router# unbundle vfc slot | Unbundles the current image of VCWare. |
router# show vfc 1 def Default List for VFC in slot 1: 1. btl-vfc-1.0.13.0.bin 2. cor-vfc-1.0.1.bin 3. bas-vfc-1.0.1.bin 4. cdc-g729-1.0.1.bin 5. fax-vfc-1.0.1.bin 6. jbc-vfc-1.0.13.0.bin
Under most circumstances, these default files should be sufficient. If you need to, you can add a file (from those stored in VFC Flash memory) to the default file list or replace an existing file from the default file list. When you add a specific file to the default file list, it replaces the existing default for that extension type.
To select a file to be added to the default file list, use the following command in global configuration mode:
| Command | Purpose |
|---|---|
Router(config)# default-file filename vfc slot | Selects a file stored in the Flash memory to be added to the default file list. |
router# show vfc 1 cap Capability List for VFC in slot 1: 1. fax-vfc-1.0.1.bin 2. bas-vfc-1.0.1.bin 3. cdc-g729-1.0.1.bin 4. cdc-g711-1.0.1.bin 5. cdc-g726-1.0.1.bin 6. cdc-g728-1.0.1.bin 7. cdc-gsmfr-1.0.1.bin
VFC management lets you add codec files to the capability list to meet the needs of your specific telephony network.
|
Note The capability list does not indicate codec preference; it simply reports the codecs that are available. The session application decides which codec to use. |
To add a codec overlay file to the capability list, use the following command in global configuration mode:
| Command | Purpose |
|---|---|
Router(config)# cap-list filename vfc slot-number | Selects a codec overlay file to be added to the capability list. |
To delete a file from VFC Flash memory, use the following command in privileged EXEC mode:
| Command | Purpose |
|---|---|
Router# delete file-name vfc slot | Deletes the specified file from VFC Flash memory. |
To erase the Flash memory of a specific VFC, use the following command in privileged EXEC mode:
| Command | Purpose |
|---|---|
Router# erase vfc slot | Erases the Flash memory on the VFC. |
For more information about VFC management commands, refer to the Cisco IOS Multiservice Applications Command Reference publication.
Before you configure your Cisco gateway to support IVR, you need to perform the following prerequisite tasks:
Configuring Store and Forward Fax involves the following configuration tasks:
These configuration tasks are described in detail in the Store and Forward Fax with ESMTP document. If you are implementing store and forward fax on modem cards, this document contains all the instructions you need.
If you are implementing store and forward fax on a VFC, one additional command is needed in configuring the on-ramp and off-ramp dial peers. These configuration instructions and procedures are repeated below. In addition, you must perform the following additional configuration tasks:
|
Note You can set up the off-ramp dial peers to steer a specific outgoing fax call to a specific T1 controller port. See the "Configuring Off-Ramp POTS Dial Peers" section of this document. |
When acting as the on-ramp gateway, the Cisco AS5300 receives faxes from end users and converts them into TIFF files, creates standard MIME e-mail messages, attaches the TIFF files to them, and then forwards these fax-mail messages to the messaging infrastructure of a designated SMTP server, where fax-mail messages are stored. The on-ramp gateway accomplishes these activities by using the sending MTA and dial peers. The sending MTA (which is the Cisco AS5300) defines delivery parameters associated with the e-mail message to which the fax TIFF file is attached. These delivery parameters include defining a return e-mail path or designating a destination mail server. The on-ramp POTS dial peers define the call as being a fax transmission and the DNIS of the incoming fax call. The on-ramp MMoIP dial peer defines the destination fax telephone number and the session target, which in this case is the SMTP server.
To configure the on-ramp gateway, perform the tasks described in the following sections:
| Command | Purpose | |
|---|---|---|
Step 1 | Router# configure terminal | Enters global configuration mode. |
Step 2 | Router(config)# fax receive called-subscriber {$d$|string}
| Defines the number that is displayed in the LCD of the sending fax machine. This parameter defines the called subscriber identification (CSI). |
Of these configuration steps, you must define the originator of the e-mail fax, the destination mail server, the subject of the message, and the postmaster, which is the default mail station for undeliverable e-mail messages. The remaining configuration steps are optional.
|
Note You use the mta send mail-from username and mta send mail-from hostname commands to configure the From: user name in the e-mail message. The To: address of the fax-mail is derived from the session target command configured for the MMoIP dial peer for the on-ramp gateway. |
To configure the sending MTA, use the following commands in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# mta send mail-from hostname string | Specifies the originator (host name portion) of the e-mail fax message. This information appears in the RFC 822 From: field and the RFC 821 MAIL FROM field of the e-mail fax message. This information is also used for generating DSNs. When you configure the mta send mail-from hostname command, the host name configured is used with the mta send mail-from username command to form a complete e-mail address, like faxuser@onramp-gateway.com. |
Step 2 | Router(config)# mta send mail-from {username string | username $s$}
| Specifies the originator (username portion) of the e-mail fax message. This information appears in the RFC 822 From: field and the RFC 821 MAIL FROM field of the e-mail fax message. This information is also used for generating DSNs. When you configure the mta send mail-from username command, the username configured is used with the mta send mail-from hostname command to form a complete e-mail address, like faxuser@onramp-gateway.com. |
Step 3 | Router(config)# mta send server {host-name | IP-address}
| Specifies the destination server. DNS MX records are not used to determine the IP address of the host specified with the mta send server command. |
Step 4 | Router(config)# mta send subject string | Defines the text that appears in the Subject field of the e-mail fax message. |
Step 5 | Router(config)# mta send postmaster e-mail-address | Defines address to be used as the mta send mail-from address if the evaluated string is blank. An address such as fax-administrator@example.com is recommended (where company.com is replaced with your domain name, and fax-administrator is aliased to the person responsible for the operation of the Cisco AS5300 fax functions). At some sites this may be the same person as the e-mail postmaster, but at most sites this is likely to be a different person. |
Step 6 | Router(config)# mta send origin-prefix string | (Optional) Defines additional identifying information to be prepended to the e-mail header. |
Step 7 | Router(config)# mta send return-receipt-to {hostname string username string}
| (Optional) Specifies the address where MDNs are sent, if you request MDN. |
On-Ramp Gateway POTS Dial Peer/Call Discrimination Process
An understanding of how the on-ramp gateway uses POTS dial peers in the course of call discrimination is helpful before you configure on-ramp POTS dial peers. First, though, some functional definitions should be created. As mentioned, store and forward fax uses either DID or a redialer to process a fax call. In both of these cases, a different telephone number is used. For the purposes of the following discussion, the term destinationDN refers to the telephone number of the fax machine where the user wants a fax to be sent and accessDN refers to the telephone number dialed by a redialer to access an on-ramp gateway.
The process of call discrimination begins when the on-ramp router receives a call. It immediately identifies whether the call is being delivered via a PRI interface or a T1-CAS interface. If the on-ramp gateway determines that the call is coming in over a T1-CAS interface, it checks the service type field of the CAS group configuration. If the service type of the CAS group is fax, it flags the call as a store and forward fax call and forwards it to the MMoIP dial peer to be processed as a fax call. If it determines that the call is coming in over a PRI interface, then the on-ramp gateway begins to look at several POTS dial peer data fields to determine what kind of call it has received.
The on-ramp gateway looks at the incoming called number field of each POTS dial peer listed in the dial peer lookup table. It compares the number configured as the incoming called number to the number received and selects the first POTS dial peer where the data matches. If the on-ramp router does not find a match, it assumes that this is a data call and processes the call accordingly.
If the on-ramp router does find a match, it will then look at the service type field of the POTS dial peer to determine whether this is a voice or fax call. If this call has been flagged as a voice call, the on-ramp gateway will process it appropriately as a voice call. If the call has been flagged as a fax call, the on-ramp gateway checks to see whether DID has been enabled. If DID has been enabled, it concludes that the telephone number it has received is the destinationDN and forwards the call to be matched with the appropriate on-ramp MMoIP dial peer.
If DID has not been enabled, the on-ramp gateway assumes that the telephone number it received is the accessDN. In this case, the on-ramp router provides a secondary dial tone and collects another telephone number from the redialer at the other end of the connection that it will use as the destinationDN. After it has received this number from the redialer, the on-ramp gateway forwards the call to be matched to the appropriate on-ramp MMoIP dial peer.
Redialers Versus DID for POTS Peers
By default, DID is disabled, which means that the on-ramp gateway assumes that the fax call it receives is being placed using a redialer. In this situation, when a call arrives on the on-ramp gateway, it presents a dial tone and collects digits until it can identify the destination, as described. After the destination has been identified, it forwards the call through to the next call leg (in this case, the MMoIP dial peer) to the destination.
If DID is enabled, the on-ramp gateway uses the called number (DNIS) to find a dial peer for the outgoing call leg. DID enables the gateway to match the incoming called number with a dial peer and then directly place the outbound call. With DID, the server does not present a dial tone to the fax machine and does not collect digits; it forwards the call directly to the configured destination.
To configure on-ramp gateway POTS dial peers, use the following commands beginning in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# dial-peer voice number pots | Defines the POTS dial peer tag number and enters dial-peer configuration mode. |
Step 2 | Router(config-dial-)# application name [out-bound] | Associates a specific IVR application with this dial peer. (The out-bound keyword is not used with POTS dial peers.) |
Step 3 | Router(config-dial-)# information-type fax | Identifies calls associated with this dial peer as being fax transmissions, as opposed to being voice calls. |
Step 4 | Router(config-dial-)# direct-inward-dial | (Optional) Specifies DID. If you are not using a redialer, you must enable DID to use store and forward fax. |
Step 5 | Router(config-dial-)# incoming called-number string | Defines the telephone number associated with the POTS dial peer--in store and forward fax, if DID is enabled, the incoming called number (DNIS number) is used to match the destination pattern of outgoing MMoIP dial peers. |
Step 6 | Router(config-dial-)# max-conn number | (Optional) Defines the maximum number of on-ramp connections used simultaneously on this Cisco AS5300 to send fax-mail. |
On-ramp MMoIP dial peers are used to define the destination fax telephone number, to specify a destination e-mail address (which in this case identifies the SMTP server), to define the image encoding and resolution specifics for the associated fax-mail TIFF files, and to request either DSNs, MDNs, or both. If you enabled DID and specified an incoming called number for the on-ramp POTS dial peer, the destination pattern of the on-ramp MMoIP dial peer should be the same as the configured incoming called number. If you did not enable DID, then you need to configure and enable a redialer to use store and forward fax. If you use a redialer, you need to configure the destination pattern to match the forwarded dialed digits from the redialer.
On-Ramp Gateway MMoIP Dial Peer/Call Discrimination Process
An understanding of how the on-ramp gateway uses MMoIP dial peers is helpful before configuring on-ramp MMoIP dial peers. As with on-ramp POTS dial peers, for the purposes of the following discussion, the term destinationDN refers to the telephone number of the fax machine where the user wants a fax to be sent, and accessDN refers to the telephone number dialed by a redialer to access an on-ramp gateway.
The function of the on-ramp call discrimination process using MMoIP dial peers is to determine the destination of the fax-mail, which in this case means the off-ramp gateway over which the fax-mail is sent to the destination fax machine.
The on-ramp gateway looks at the destination pattern field of each MMoIP dial peer listed in the dial peer lookup table. It compares the number configured as the destination pattern to the number received and selects the first MMoIP dial peer where the data matches. The on-ramp gateway then looks at the session target field for the selected MMoIP dial peer to identify the destination of the fax-mail message--this could be a specific off-ramp gateway for a store and forward fax or, if the fax is being delivered as an e-mail message, an e-mail address for a specific mail server.
Image Encoding and Image Resolution
Depending on the capacity of the fax machines in your network, you might want to use a different image encoding (compression) scheme for the fax TIFF image store and forward fax creates. As a default, image encoding in store and forward fax is set to passthrough, which means that the image is forwarded exactly as it is received. If you want to specify a specific encoding (compression) scheme for the fax TIFF image, use the image encoding dial-peer configuration command.
DSN
Because these delivery states are not mutually exclusive, you can configure store and forward fax to generate these messages for all or any combination of these events.
You enable DSN requests as part of the on-ramp MMoIP dial peer configuration. For complete instructions on how to configure DSNs using store and forward fax, refer to the "Configuring Delivery Status Notification" section later in this chapter.
MDN
To configure on-ramp gateway MMoIP dial peers, use the following commands beginning in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# dial-peer voice number mmoip | Defines the MMoIP dial peer tag number and enters dial-peer configuration mode. |
Step 2 | Router(config-dial-)# application name [out-bound] | Associates a specific IVR application with this dial peer. If the out-bound keyword is used, the named application will handle the MMOIP dial peer in the outgoing mode. |
Step 3 | Router(config-dial-)# destination-pattern [+]string | Identifies the destination fax telephone number. If DNIS has been enabled, this number should be the same as the configured incoming called number. If DNIS is not enabled, this should be the number from the redialer DNIS. |
Step 4 | Router(config-dial-)# session target {mailto:{name | $d$}@domain-name | ipv4:destination-address | dns:[$s$. | $d$. | $u$. | $e$.] host-name| loopback:rtp |loopback:compressed | loopback:uncompressed}
| Defines the destination e-mail address for the fax-mail, meaning the e-mail address identifying the SMTP server. |
Step 5 | Router(config-dial-)# session protocol smtp | Identifies the session protocol being used between the on-ramp gateway and the remote mail server as SMTP. |
Step 6 | Router(config-dial-)# image encoding {mh | mr | mmr | passthrough}
| Selects a specific encoding method for the fax-mail messages forwarded via this dial peer. |
Step 7 | Router(config-dial-)# image resolution {fine | standard | super-fine | passthrough}
| Selects a specific resolution for the TIFF images attached to the fax-mail message forwarded vis this dial peer. |
Step 8 | Router(config-dial-)# max-conn number | (Optional) Defines the maximum number of connections used simultaneously on this Cisco AS5300 to send fax-mail. |
Step 9 | Router(config-dial-)# dsn {delay | failure | success}
| (Optional) Requests that a delivery status notification be generated by the last hop mailer if the delivery was successful. This DSN is sent to the address specified by the mta send mail-from command. Three types of DSNs can be requested: delay, failure, and success. DSN must be supported by the remote mail server. |
Step 10 | Router(config-dial-)# mdn | (Optional) Requests that a message disposition notification be generated by the mail user agent when the message is processed (typically opened or read). The MDN is generated by the receiving mail user agent and sent to the address defined by the mta send return-receipt-to command. Return receipt must be supported/initiated by the receiving e-mail client. |
As a default, store and forward fax receives faxes on modems that are in the on-ramp gateway default modem pool--meaning that these modems are available for both fax and data calls. The on-ramp gateway determines the call type by using the DNIS. The on-ramp gateway compares the DNIS to the configured value for the incoming called-number POTS dial-peer configuration command; if the DNIS matches the incoming called number, then it treats the call as a fax transmission. If it does not find a match in its dial peer lookup table, it treats the call as a data call.
You can specify which incoming fax calls will not be presented to the default modem pool by defining a named modem pool. This is particularly useful if you have both MICA and Microcom faxes; it allows you to divert fax traffic from MICA modems, which at this time do not support fax transmission.
To configure on-ramp modem pooling, use the following commands beginning in privileged EXEC mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router# configure terminal | Enters global configuration mode. |
Step 2 | Router(config)# modem-pool name | Creates a modem pool. |
Step 3 | Router(config)# pool-range number-number | Assigns a range of modems to the specified modem pool. |
You need to enable Cisco routers and access servers to support the Nagle congestion control algorithm. To optimize store and forward fax performance and to avoid packet congestion, enable the Nagle congestion control algorithm by using the service nagle global configuration command.
To enable the Nagle Congestion Algorithm, use the following command in global configuration mode:
| Command | Purpose |
|---|---|
Router(config)# service nagle | (Optional) Enables the Nagle congestion control algorithm to optimize store and forward fax performance. |
|
Note There may be unexpected side effects with other services that run over TCP sockets on this same Cisco AS5300 if you enable the Nagle congestion algorithm when using store and forward fax. However, we are unaware of any side effects at this time. |
The off-ramp gateway performs the following activities:
|
Note Off-ramp faxing activities are not mutually exclusive. You can create an e-mail to be sent as a fax and attach a TIFF file to it; when the Cisco AS5300 converts the e-mail to fax format, it also converts the attached TIFF file to standard Group 3 fax format. |
The off-ramp gateway usually uses only POTS dial peers to define the line characteristics between the off-ramp gateway forwarding the converted e-mail message and the fax device; as an option, you can configure MMoIP dial peers, but MMoIP dial peers have limited functionality in off-ramp faxing activities. In general, off-ramp MMoIP dial peers merely define fax compression schemes and resolution and are useful only if you want to alter those parameters for the fax-mails being received.
|
Note You can set up the off-ramp dial peers to steer specific outgoing fax calls to a specific T1 controller port. This capability enables you to route certain calls to a T1 trunk that may have a different rate structure. See the "Configuring Off-Ramp POTS Dial Peers" section of this document. |
The off-ramp gateway uses receiving MTAs to define the parameters associated with the AS5300 SMTP server, such as its SMTP host alias(es), which can be different than its normal DNS host name(s) or internal Cisco IOS host name. Off-ramp POTS dial peers basically define the telephone number of the destination fax device. Because a destination pattern is defined for an outbound POTS peer, you can use number expansion.
To configure the off-ramp gateway, perform the tasks in the following sections:
The first four tasks are applicable to all off-ramp faxing activities. The last two tasks apply only to off-ramp faxing activities where the fax transmission originates as an e-mail message.
To configure the transmitting subscriber number, use the following commands beginning in privileged EXEC mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router# configure terminal | Enters global configuration mode. |
Step 2 | Router(config)# fax send transmitting-subscriber {$d$ | string}
| Defines the number that appears in the LCD of the receiving fax device. This parameter defines the transmitting subscriber identification (TSI). |
To configure the fax transmission speed, use the following command in global configuration mode:
| Command | Purpose |
|---|---|
Router (config)# fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 7600}
| Specifies the maximum speed at which an off-ramp fax is sent. |
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# mta receive aliases string | Defines a host name to be used as an alias for the off-ramp Cisco AS5300 device. You can define up to ten different aliases. The Cisco AS5300 SMTP server will only accept incoming mail if the destination host name of the incoming mail matches one of the aliases as configured by the mta receive aliases command. This command does not automatically include reception for a domain IP address--it must be explicitly added. If you add an IP address, you must enclose the address in brackets as follows: [xxx.xxx.xxx.xxx]. |
Step 2 | Router(config)# mta receive generate-mdn | (Optional) Configures the Cisco AS5300 to actually generate an MDN message when requested to do so. Some sites may want to enable or disable this feature depending on the types of mailers in use. |
Step 3 | Router(config)# | Defines the number of simultaneous SMTP recipients handled by this device. This is intended to limit the number of resources (modems) allocated for fax transmissions. |
Only two resolutions are available for this release: standard and fine. If you select any other image resolution command options (such as passthrough or super-fine), the fax will be sent using the fine resolution. Encoding type defines the type of compression scheme the off-ramp gateway uses for the TIFF image. There are four available compression options: Modified Huffman, Modified Read, Modified Modified Read, and passthrough.
Off-Ramp Gateway MMoIP Dial Peer/Call Discrimination Process
Once again, understanding how the off-ramp gateway uses MMoIP dial peers in the course of call discrimination is helpful before you configure off-ramp MMoIP dial peers. For the purposes of the following discussion, the term destinationDN refers to the telephone number of the fax machine where the user wants a fax to be sent, and accessDN refers to the telephone number dialed by a redialer to access an on-ramp gateway. For the on-ramp gateway to forward the fax-mail to the appropriate SMTP server, it converts the destinationDN into an e-mail address. The left side of this address is the destinationDN; the right side of this e-mail address defines the domain.
When the off-ramp router receives the fax-mail message, it looks at the destinationDN portion of the e-mail address and tries to match that value with the incoming called number field for each of the defined off-ramp MMoIP dial peers in its lookup table. If the off-ramp gateway finds an appropriate match, it uses the specified resolution and encoding values for the fax-mail message. If it cannot find a match, or if no resolution or encoding information has been defined for a matched off-ramp MMoIP dial peer, it applies fine resolution and non (passthrough) encoding for those parameters.
To configure off-ramp gateway MMoIP dial peers, use the following commands beginning in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# dial-peer voice number mmoip | Defines the MMoIP dial peer tag number and enters dial-peer configuration mode |
Step 2 | Router(config-dial-)# application name [out-bound] | Associates a specific IVR application with this dial peer. If the out-bound keyword is used, the named application will handle the MMOIP dial peer in the outgoing mode. |
Step 3 | Router(config-dial-)# information-type fax | Identifies calls associated with this dial peer as being fax transmissions, as opposed to strictly being voice calls. |
Step 4 | Router(config-dial-)# incoming called-number string | Identifies the destination fax telephone number. |
Step 5 | Router(config-dial-)# image resolution {fine | standard | super-fine | passthrough}
| Specifies the fax image resolution for TIFF files associated with this particular MMoIP dial peer. Only standard and fine fax resolutions are supported for Cisco IOS Release 12.1. |
Step 6 | Router(config-dial-)# image encoding {mh | mr | mmr | passthrough}
| Specifies the type of encoding to be used for TIFF files associated with this MMoIP dial peer. |
Off-Ramp Gateway POTS Dial Peer/Call Discrimination Process
Once again, understanding how the off-ramp gateway uses POTS dial peers in the course of call discrimination is helpful before you configure off-ramp POTS dial peers. For the purposes of the following discussion, the term destinationDN refers to the telephone number of the fax machine where the user wants a fax to be sent, and accessDN refers to the telephone number dialed by a redialer to access an on-ramp gateway. For the on-ramp gateway to forward the fax-mail to the appropriate SMTP server, it converts the destinationDN into an e-mail address. The left side of this address is the destinationDN; the right side of this e-mail address defines the domain.
The off-ramp gateway looks at the destination-pattern field of each POTS dial peer listed in the dial peer lookup table. It compares the number configured as the destination pattern to the destination DN portion of the fax-mail address and selects the first POTS dial peer where the data matches.
After the off-ramp gateway identifies the appropriate POTS dial peer, it then matches call type information. If the call type is identified as fax, it forwards the fax-mail message to off-ramp services. If the off-ramp router does not find a match, the recipient identified by this address will not be accepted by the off-ramp router.
To generate E.164 e-mail addresses compliant with RFC 2304, use the following address format: fax=+$d$@your.hostname.com. If the off-ramp gateway receives this type of e-mail address, it strips the + and matches an off-ramp POTS dial peer on the remaining digits.The number contained in "$d$" must be a fully qualified E.164 telephone number (that is, it must include the country code) and it must not include an access code (such as "9" to get an outside line).
To configure off-ramp gateway POTS dial peers, use the following commands beginning in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# dial-peer voice number pots | Defines the POTS dial peer tag number and enter dial-peer configuration mode. |
Step 2 | Router(config-dial-)# application name [out-bound] | Associates a specific IVR application with this dial peer. (The out-bound keyword is not used with POTS dial peers.) |
Step 3 | Router(config-dial-)# information-type fax | Identifies calls associated with this dial peer as being fax transmissions, as opposed to strictly being voice calls. |
Step 4 | Router(config-dial-)# destination-pattern [+]stringT | Identifies the destination fax telephone number. |
Step 5 | Router(config-dial-)# | (Optional) Specifies the T1 controller port through which to route the outgoing fax calls for this dial peer. |
Step 6 | Router(config-dial-)# | (Optional) Specifies the prefix of the dialed digits associated with this dial peer. If you configure a prefix, when an outgoing call is initiated, the prefix string value is sent to the modem first, before the telephone number configured for this dial peer. |
Store and forward fax lets you convert standard e-mail messages into fax transmissions. When you send a fax using a standard Group 3 device, there is usually header information appended to the top of each faxed cover and text page, indicating (among other things) the telephone number of the sending fax device, the date, and the time of transmission. Faxes created using an e-mail application need that header information appended to each faxed page. Store and forward fax lets you configure exactly what header information is appended to the top of each faxed cover and text page, along with its placement. In addition, you can also use the destination address of an e-mail message to control the cover page generation on a per-recipient basis.
|
Note Because the off-ramp gateway does not alter fax TIFF attachments, you cannot configure faxed header information for faxes being converted from TIFF files to standard fax transmissions. |
To configure faxed header information, use the following commands in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# fax send center-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
| Specifies the header information to be displayed in the center position. The wildcards used in this command are used to insert the following information:
You use the string argument in this command to insert personalized text string. |
Step 2 | Router(config)# fax send right-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
| Specifies the header information to be displayed on the right. The wildcards used in this command are used to insert the following information:
You use the string argument in this command to insert personalized text string. |
Step 3 | Router(config)# fax send left-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
| Specifies the header information to be displayed on the left. The wildcards used in this command are used to insert the following information:
You use the string variable in this command to insert personalized text string. |
|
Note Because the off-ramp gateway does not alter fax TIFF attachments, you cannot configure cover pages for faxes being converted from TIFF files to standard fax transmissions. |
To configure fax cover page information, use the following commands in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# fax send coverpage enable | Enables the off-ramp gateway to send a cover sheet with faxes that originate from e-mail messages. |
Step 2 | Router(config)# fax send coverpage comment string | (Optional) Adds personalized text in the title field of the fax cover sheet. |
Step 3 | Router(config)# fax send coverpage show-detail | (Optional) Prints all of the e-mail header information as part of the fax cover sheet text. |
You can also use the destination address of an e-mail message to control the cover page generation on a per-recipient basis. You use the fax send coverpage e-mail-controllable command to configure the router to defer to the cover page setting in the e-mail header.
In essence, the off-ramp router defers to the setting configured in the e-mail address itself. For example, if the address has a parameter set to cover=no, this parameter will override the setting for the fax send coverpage enable command and the off-ramp gateway will not generate and send a fax cover page. If the address has a parameter set to cover=yes, the off-ramp gateway will defer to the setting configured in the e-mail address and generate and send a fax cover page.
Table 4 contains examples of what the user would enter in the To: field of the e-mail message.
| Example for To: Field Entries | Description |
|---|---|
FAX=+1-312-555-3260@fax.com | Fax sent to an E.164-compliant long distance telephone number in the United States. If the fax coverpage enable command has been configured, store and forward fax will generate a fax cover page. |
FAX=+1-312-555-3260/cover=no@fax.com | Fax sent to an E.164-compliant long distance telephone number in the United States. In this example, the fax coverpage enable command is superseded by the cover=no statement. No cover page will be generated. |
FAX=+1-312-555-3260/cover=yes@fax.com | Fax sent to an E.164-compliant long distance telephone number in the United States. In this example, the fax coverpage enable command is superseded by the cover=yes statement. Store and forward fax will generate a fax cover page. |
FAX=+1-312-555-3260/T33S=123456@fax.com | Fax sent to an E.164-compliant long distance telephone number in the United States; this example has an attached T.33 substring. |
FAX=+49-515-555-5637@faxgateway.com | Fax sent to an E.164-compliant long distance telephone number in Germany. |
FAX=+61-2-555-8765@fax.host.com | Fax sent to an E.164-compliant long distance telephone number in Australia. |
FAX=+33-65-555-5555@fax.com | Fax sent to an E.164-compliant long distance telephone number in France. |
To configure the router to defer to the cover page setting in the e-mail header, use the following commands in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# fax send coverpage enable | Enables the off-ramp gateway to send a cover page with faxes that originate from e-mail messages. |
Step 2 | Router(config)# fax send coverpage e-mail controllable | Configures the router to defer to the cover page setting in the e-mail header. For example, if the address has a parameter set to cover=no or cover=yes, it will override the setting for the fax send coverpage enable command. |
You can verify the off-ramp gateway configuration by performing the following tasks:
To configure IVR functionality using either classic or TCL scripts, perform the following tasks after you have completed the prerequisite steps:
To configure IVR, use the following commands beginning in privileged EXEC mode:
| Command | Purpose | |||
|---|---|---|---|---|
Step 1 | | Enters global configuration mode. | ||
Step 2 | | Defines the name to be referenced for your application and indicates the location (URL) of the appropriate IVR script to be used with this application.
| ||
Step 3 | | (Optional depending on the TCL script you select) Defines the language of the audio file for the designated application and passes that information to the application. | ||
Step 4 | | (Optional depending on the TCL script you select) Defines the number of characters in the PIN for the designated application and passes that information to the application. | ||
Step 5 | | (Optional depending on the TCL script you select) Defines the number of times a caller is permitted to reenter the PIN for the designated application and passes that information to the application. | ||
Step 6 | | (Optional depending on the TCL script you select) Defines the number of characters in the UID for the designated application and passes that information to the application. | ||
Step 7 | | (Optional depending on the TCL script you select) Defines the location, language, and category of the audio files for the designated application and passes that information to the application. | ||
Step 8 | | Enables AAA security and accounting services. | ||
Step 9 | | Enables gateway-specific H.323 accounting. | ||
Step 10 | | Defines a method list called h323 where RADIUS is defined as the only method of login authentication. | ||
Step 11 | | Defines a method list called h323 where RADIUS is used to perform connection accounting, providing start-stop records. | ||
Step 12 | | Identifies the RADIUS server and the ports that will be used for authentication and accounting services. | ||
Step 13 | | Specifies the password used between the gateway and the RADIUS server. | ||
Step 14 | | Enter the dial-peer configuration mode to configure the incoming POTS dial peer. The number value of the dial-peer voice pots command is a tag that uniquely identifies the dial peer. | ||
Step 15 | | Associates the IVR application with the incoming POTS dial peer. | ||
Step 16 |
| Defines the telephone number associated with this dial peer. | ||
Step 17 | | Defines the voice port associated with this dial peer. |
Table 5 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
You can verify IVR configuration by performing the following tasks:
Fax calls cannot be made on modem cards and VFC cards simultaneously. When both types of interface cards are present in the Cisco AS5300 chassis, you must select the interface type on which you wish to make fax calls.
To specify the interface type you wish to use for fax calls, use the following command in global configuration mode:
| Command | Purpose |
|---|---|
Router(config)# fax interface-type {modem | vfc}
| Specifies the interface type that will be enabled for fax calls. |
To specify the names and locations of the IVR scripts containing the TCL application files for onramp and offramp operation, use the following command in global configuration mode:
| Command | Purpose | ||
|---|---|---|---|
Router(config)# call application voice application-name location | Specifies the name and TFTP server location of an IVR script used to handle on-ramp or off-ramp fax operations.
|
To configure gateway security for the TCL application files being used for fax calls on a VFC, use the following commands in global configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# call application voice application-name accounting enable | Enables AAA accounting services for the named application. |
Step 2 | Router(config)# call application voice application-name authentication enable | Enables AAA authentication services for the named application. |
Step 3 | Router(config)# | Specifies the name of an authentication method list for the named application. |
Step 4 | Router(config)# | Specifies the name of the authentication method for the named application. Valid authentication methods are prompt-user, gateway, ANI, DNIS, redialer DMS, and redialer serial number. |
To associate a TCL application file with a dial peer, use the following command in dial-peer configuration mode:
| Command | Purpose | |
|---|---|---|
Step 1 | Router(config)# | Specifies a dial-peer type and enters dial-peer configuration mode. |
Step 2 | Router(config-dial-peer)# | Associates the named TCL application with the specified dial peer. Use the out-bound keyword when the application handles the dial peer in outgoing mode. |
The following is an annotated sample configuration for store and forward fax and fax relay using VFCs on a Cisco AS5300 access server:
Reference configuration for Store and Forward Fax and Fax Relay ! using VFCs on a Cisco AS5300 ! ! version 12.1 service timestamps debug uptime service timestamps log uptime no service password-encryption service internal service udp-small-servers service tcp-small-servers ! hostname fax-gateway ! aaa new-model aaa authentication login fax group radius local aaa authorization exec fax group radius aaa accounting connection fax stop-only group radius enable password lab ! username betatest password 0 password ! ! ip subnet-zero ip host dirt 223.255.254.254 ip domain-name cisco.com ip name-server 1.14.116.1 ! mgcp package-capability trunk-package mgcp default-package trunk-package isdn switch-type primary-5ess isdn voice-call-failure 0 ! ! used for fallback from T.38 fax relay to T.37 fax voice hunt user-busy ! ! global service for fax relay voice service voip fax protocol t38 ls_redundancy 0 hs_redundancy 0 ! ! call application voice app_libretto_offramp5 tftp://dirt/libretto-test/app_libretto_offramp5.tcl call application voice app_libretto_offramp5 authen-list fax call application voice app_libretto_offramp5 authen-method gateway call application voice app_libretto_offramp5 accounting-list fax ! call application voice app_onramp9 tftp://dirt/libretto-test/app_libretto_onramp9.tcl call application voice app_onramp9 authen-list fax call application voice app_onramp9 authen-method gateway call application voice app_onramp9 language 1 en call application voice app_onramp9 accounting-list fax call application voice app_onramp9 set-location en 0 tftp://dirt/cchiu/WV/en_new/ ! ! fax receive called-subscriber $d$ fax send transmitting-subscriber $s$ fax send left-header $s$ fax send center-header $t$ fax send right-header Page: $p$ fax send coverpage enable fax send coverpage email-controllable fax send coverpage comment Cisco cover page comment fax interface-type vfc mta send server 1.14.116.1 mta send subject faxmail subject line here mta send origin-prefix Cisco Powered Fax System mta send postmaster postmaster@mail-server.cisco.com mta send mail-from hostname fax-gateway.com mta send mail-from username fax-user mta send return-receipt-to hostname return.host.com mta send return-receipt-to username $s$ mta receive aliases mmoip-b.cisco.com mta receive aliases cisco.com mta receive aliases [1.14.120.2] mta receive maximum-recipients 80 mta receive generate-mdn ! ! controller T1 0 framing esf clock source line primary linecode b8zs pri-group timeslots 1-24 ! ! ! interface Ethernet0 ip address 1.14.120.2 255.255.0.0 no ip directed-broadcast ! interface Serial0:23 no ip address no ip directed-broadcast no ip route-cache isdn switch-type primary-5ess isdn incoming-voice modem no fair-queue ! ! interface FastEthernet0 no ip address no ip directed-broadcast shutdown duplex auto speed auto ! ! ip default-gateway 1.14.0.1 ip classless ip route 223.255.254.0 255.255.255.0 1.14.0.1 no ip http server ! ! radius-server host 1.14.116.1 auth-port 1645 acct-port 1646 radius-server retransmit 3 radius-server key password radius-server vsa send accounting radius-server vsa send authentication ! voice-port 0:D no modem passthrough ! ! Inbound peer for T.37 onramp operation dial-peer voice 2 pots application app_onramp9 incoming called-number 5...... direct-inward-dial ! ! ! Outbound peer for T.37 onramp operation dial-peer voice 3 mmoip ! The application name below must be exactly as shown! application fax_on_vfc_onramp_ap out-bound destination-pattern 57108.. session target mailto:$d$@mail-server.cisco.com ! MDN and DSN configuration can be set in this peer ! ! Inbound peer for T.37 offramp operation dial-peer voice 21 mmoip application lib_off_app5 incoming called-number 5...... information-type fax ! ! ! Outbound peer for T.37 offramp operation dial-peer voice 20 pots destination-pattern 5...... port 0:D prefix 5 ! ! ! Notice that the pots 20 peer has "port 0:D" which ! means that when this peer is matched, controller : T1-0 will be used for the outgoing call. ! ! The following peers are for two different gateways ! processing the same call for T.38 ! ! Inbound peer for T.38 ingress gateway dial-peer voice 50 pots incoming called-number 1800555.... ! ! Outbound peer for T.38 ingress gateway dial-peer voice 51 voip destination-pattern 57108.. session target ipv4:12.22.95.20 ! ! Inbound peer for T.38 egress gateway dial-peer voice 61 voip incoming called-number 57108.. ! ! ! Outbound peer for T.38 egress gateway dial-peer voice 60 pots destination-pattern 57108.. port 0:D prefix 57108 ! ! ! The following set of 3 peers are for onramp T.38 fax rollover to T.37 fax ! Rollover occurs when the destination fax line is busy ! ! The following configuration command must be set for T.38 rollover to T.37 voice hunt user-busy ! ! ! Inbound peer for T.38/T.37 onramp rollover operation ! This peer includes the TCL application for rollover operation dial-peer voice 70 pots application app_lib_rollover15 incoming called-number 5...... ! ! ! Outbound peer for T.38 ingress gateway ! This peer requires lower preference number then next matching peer dial-peer voice 71 voip preference 1 destination-pattern 3746096 session target ipv4:1.14.120.109 fax protocol t38 ls_redundancy 0 hs_redundancy 0 ! ! ! Outbound peer for T.37 onramp operation dial-peer voice 72 mmoip preference 2 ! The application name below must be exactly as shown! application fax_on_vfc_onramp_ap out-bound destination-pattern 3746096 session target mailto:$d$@mail-server.cisco.com ! ! ! line con 0 exec-timeout 0 0 transport input all line aux 0 line vty 0 4 exec-timeout 0 0 password password ! end
This section documents new or modified commands for the T.37/T.38 Fax Gateway feature. All other commands used with this feature are documented in the Cisco IOS Release 12.0(4)XJ Store and Forward Fax feature and in the Cisco IOS Release 12.1 Cisco IOS Multiservice Applications Command Reference.
To enable a specific interactive voice response (IVR) 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]
Syntax Description
name Indicates the name of the predefined IVR application. Incoming calls using this POTS dial peer, and outgoing calls using the MMOIP dial peer, will be handed off to this application. out-bound The named application will handle the MMOIP dial peer in the outgoing mode.
Defaults
No default behavior or values.
Command Modes
Dial-peer configuration mode
Command History
11.3(6)NA2 This command was introduced. 12.0(5)T The SGCPAPP application was first supported on the Cisco AS5300 in a private release not generally available. 12.0(7)XK Support for the SGCPAPP application was extended to the Cisco MC3810 and the Cisco 3600 series routers (except for the Cisco 3620) in a private release that was not publically available. 12.1(3)XI The out-bound keyword was added for the store and forward fax feature on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Use this command when configuring interactive voice response (IVR) or any of the IVR-related features to associate a predefined session application with an incoming POTS dial peer or an outgoing MMOIP dial peer. Calls using this incoming POTS dial peer or this outgoing MMOIP dial peer will be handed to the predefined specified session application.
Examples
This following example shows how to define an application and how to apply it to an incoming POTS dial peer:
Router(config)# call application voice c4 tftp://santa/username/clid_4digits_npw_3.tcl Router(config)# ! Router(config-if)# dial-peer voice 100 pots Router(config-dial-peer)# application c4 Router(config-dial-peer)#
Related Commands
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.
Command
Description
Syntax Description
application-name User-defined character string that names the application located at the URL specified in location. location The location of the TCL file in URL format. Valid storage locations are TFTP, FTP, and Flash.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(7)T This command was introduced.
Release
Modification
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.
Examples
This example shows how to define the application "prepaid" and the TFTP server location of the associated TCL script:
Router(config)# call application voice prepaid tftp://keyer/debitcard.tcl
Related Commands
call application voice access-method Specifies the access method for the designated 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 Reload the designated TCL script. call application voice pin-len Defines the number of characters in the personal identification number (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 example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
To specify the access method for two-stage dialing for the designated application, use the call application voice access-method command in global configuration mode. To restore default values for this command, use the no form of this command.
call application voice application-name access-method {prompt-user | redialer}
Syntax Description
application-name The name of the application. prompt-user Specifies that no DID is set in the incoming POTS dial peer and that a TCL script in the incoming POTS dial peer will be used for two-stage dialing. redialer Specifies that no DID is set in the incoming POTS dial peer and that the redialer device will be used for two-stage dialing.
Defaults
prompt-user (when DID is not set in the dial peer)
Command Modes
Global configuration mode
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Use the call application voice access-method command to specify the access method for two-stage dialing when DID is disabled in the POTS dial peer.
Examples
The following example specifies prompt-user as the access method for two-stage dialing for the app_onramp6 IVR application:
Router(config)# call application voice app_onramp6 access-method prompt-user
Related Commands
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 Reload the designated TCL script. call application voice pin-len Defines the number of characters in the personal identification number (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 example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
To enable AAA accounting for a TCL application, use the call application voice accounting command in global configuration mode. To disable accounting for a TCL application, use the no form of this command.
call application voice application-name accounting enable
Syntax Description
application-name The name of the application.
Defaults
Disabled
Command Modes
Global configuration
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
This command enables AAA accounting services if a AAA accounting method list has been defined using both the aaa accounting command and the mmoip aaa method fax accounting command.
This command applies to off-ramp store and forward fax functions on AS5300 voice feature cards. It is not used on modem cards.
Examples
The following example enables a AAA accounting to be used with outbound store and forward fax:
Router(config)# call application voice app_onramp6 accounting enable
Related Commands
mmoip aaa method fax accounting Defines the name of the method list to be used for AAA accounting with store and forward fax.
Command
Description
To define the name of the method list to be used for AAA accounting with store and forward fax on a voice feature card, use the call application voice accounting-list global configuration command. Use the no form of this command to restore the default value.
call application voice application-name accounting-list method-list-name
Syntax Description
application-name The name of the application. method-list-name Character string used to name a list of accounting methods to be used with store and forward fax.
Defaults
No AAA accounting method list defined.
Command Modes
Global configuration mode
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
This command defines the name of the AAA accounting method list to be used with store and forward fax. The method list itself, which defines the type of accounting services provided for store and forward fax, is defined using the aaa accounting global configuration command. Unlike standard AAA (where each defined method list can be applied to specific interfaces and lines), the AAA accounting method lists used in store and forward fax are applied globally on the Cisco AS5300.
After the accounting method lists have been defined, they are enabled by using the mmoip aaa receive-accounting enable command.
This command applies to both on-ramp and off-ramp store and forward fax functions on AS5300 voice feature cards. It is not used on modem cards.
Examples
The following example defines a AAA accounting method list (called sherman) to be used with store and forward fax:
Router(config)# aaa new-model Router(config)# call application voice app_onramp6 accounting-list sherman
Related Commands
call application voice accounting enable Enables on-ramp AAA accounting services.
Command
Description
To enable AAA authentication services for a TCL application, use the call application voice authentication command in global configuration mode. To disable authentication for a TCL application, use the no form of this command.
call application voice application-name authentication enable
Syntax Description
application-name The name of the application.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
This command enables AAA authentication services for a TCL application if a AAA authentication method list has been defined using both the aaa authentication command and the call application voice authen-list command.
Examples
The following example enables a AAA authentication method list (called peabody) to be used with outbound store and forward fax.
Router(config)# aaa new-model Router(config)# call application voice app_onramp6 authen-list peabody Router(config)# call application voice app_onramp6 authentication enable
Related Commands
call application voice authen-list Specifies the name of an authentication method list for a TCL application. call application voice authen-method Specifies the authentication method for a TCL application.
Command
Description
To specify the name of an authentication method list for a TCL application, use the call application voice authen-list command in global configuration mode. To disable the authentication method list for a TCL application, use the no form of this command.
call application voice application-name authen-list method-list-name
Syntax Description
application-name The name of the application. method-list-name Character string used to name a list of authentication methods to be used with T.38 fax relay and T.37 store and forward fax.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
This command defines the name of the AAA authentication method list to be used with fax applications on voice feature cards. The method list itself, which defines the type of authentication services provided for store and forward fax, is defined using the aaa authentication global configuration command. Unlike standard AAA (where each defined method list can be applied to specific interfaces and lines), AAA authentication method lists used with fax applications are applied globally on the Cisco AS5300.
After the authentication method lists have been defined, they are enabled by using the call application voice authentication enable command.
Examples
The following example defines a AAA authentication method list (called fax) to be used with T.38 fax relay and T.37 store and forward fax:
Router(config)# call application voice app_onramp6 authen-list fax
Related Commands
call application voice authentication enable Enables AAA authentication services for a TCL application. call application voice authen-method Specifies the authentication method for a TCL application.
Command
Description
To specify a AAA authentication method for a TCL application, use the call application voice authen-method command in global configuration mode. To disable the authentication method for a TCL application, use the no form of this command.
call application voice application-name authen-method {prompt-user | ani | dnis | gateway | redialer-id | redialer-dnis}
Syntax Description
application-name The name of the application. prompt-user Indicates that the user is prompted for the TCL application account identifier. ani Indicates that the calling party telephone number (automatic number identification or ANI) is used as the TCL application account identifier. dnis Indicates that the called party telephone number (dialed number identification service or DNIS) is used as the TCL application account identifier. gateway Indicates that the router-specific name derived from the host name and domain name is used as the TCL application account identifier, displayed in the following format: router-name.domain-name. redialer-id Indicates that the account string returned by the external redialer device is used as the TCL application account identifier. In this case, the redialer ID is either the redialer serial number or the redialer account number. redialer-dnis Indicates that the called party telephone number (dialed number identification service or DNIS) is used as the TCL application account identifier captured by the redialer if a redialer device is present.
Defaults
No default behavior or values.
Command Modes
Global configuration mode
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Normally, when AAA is being used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With T.37 store and forward fax and T.38 real-time fax, you can specify that the ANI, DNIS, gateway ID, redialer ID, or redialer DNIS be used to identify the user for authentication, or that the user be prompted for the TCL application .
Examples
The following example shows how to configure the router-specific name derived from the host name and domain name as the TCL application account identifier for the app_onramp6 TCL application:
Router(config)# call application voice app_onramp6 authen-method gateway
Related Commands
call application voice authentication enable Enables AAA authentication services for a TCL application. call application voice authen-list Specifies the name of an authentication method list for a TCL application.
Command
Description
To define a password to be used with CiscoSecure for Windows NT when using store and forward fax on a voice feature card, use the call application voice global-password global configuration command. Use the no form of this command to restore the default value.
call application voice application-name global-password password
Syntax Description
application-name The name of the application. password Character string used to define the CiscoSecure for Windows NT password to be used with store and forward fax. Maximum length is 64 alphanumeric characters.
Defaults
No password defined.
Command Modes
Global configuration
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
CiscoSecure for Windows NT might require a separate password in order to complete authentication, no matter what security protocol you use. This command defines the password to be used with CiscoSecure for Windows NT. All records on the Windows NT server use this defined password.
This command applies to on-ramp store and forward fax functions on AS5300 voice feature cards. It is not used on modem cards.
Examples
The following example defines a password (abercrombie) for use by AAA for the app_onramp6 TCL application:
Router(config)# call application voice app_onramp6 global-password abercrombie
Syntax Description
application-name The name of the application to which the language parameters are being passed. number Tag that uniquely identifies an audio file. Valid entries are 0 to 9. language Defines the language of the associated audio file. Valid entries are:
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the 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 6 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
Examples
The following example shows how to define English and Spanish as the languages of the audio files associated with the application named prepaid:
Router(config)# call application voice prepaid language 1 en Router(config)# call application voice prepaid language 2 sp
Related Commands
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 Reload the designated TCL script. call application voice pin-len Defines the number of characters in the PIN for the application and passes that information to the application. call application voice redirect-number Defines the telephone number to which a call will be redirected--for example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
Syntax Description
name Defines the TCL application to use for the call.
Defaults
No default behavior or values.
Command Modes
Privileged EXEC
Command History
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
The software checks the signature lock to ensure it is a Cisco-supported TCL script.
|
Note If the TCL script does not have a valid Cisco-supported signature, the software fails to load the script and generates the following error message:00:02:54: %IVR-3-BAD_IVR_SIG: Script signature is invalid |
Examples
The following example shows how to reload the TCL script called clid_4digits_npw_3.tcl:
Router(config)# call application voice load clid_4digits_npw_3.tclj
Syntax Description
application-name The name of the application to which the PIN length parameter is being passed. number Defines the number of allowable characters in PINs associated with the specified application. Valid entries are 0 to 10.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the 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 7 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
Examples
The following example shows how to define a PIN length of 4 characters for the application named prepaid:
Router(config)# call application voice prepaid pin-len 4
Related Commands
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 Reload this designated TCL script. call application voice redirect-number Defines the telephone number to which a call will be redirected--for example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
Syntax Description
application-name The name of the application to which the redirect telephone number parameter is being passed. number Defines the 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
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the 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 8 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
Examples
The following example shows how to define a redirect number for the application named prepaid:
Router(config)# call application voice prepaid redirect-number 5551111
Related Commands
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 Reload the designated TCL script. call application voice pin-len Defines the number of characters in the PIN for the application and passes that information to the application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
Syntax Description
application-name The name of the application to which the number of possible retries is being passed. number Defines the number of times the caller is permitted to re-enter PIN digits.Valid entries for this parameter are 1 to 5.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the 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 9 lists TCL script names and the corresponding parameters that are required for each TCL scripts
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
Examples
The following example shows how to define that a user can re-enter a PIN 3 times before being disconnected for the application named prepaid:
Router(config)# call application voice prepaid retry-count 3
Related Commands
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 Reload the designated TCL script. call application voice pin-len Defines the number of characters in the PIN for the application and passes that information to the application. call application voice redirect-number Defines the telephone number to which a call will be redirected--for example, the operator telephone number of the service provider--for the designated application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
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 are: category Defines a particular category group. Audio files can be divided into category groups (from 0 to 4). For example, audio files representing the days and months can be category 1, audio files representing units of currency can be category 2, audio files representing units of time: seconds, minutes, and hours can be category 3. Min = 0, Max = 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
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the TCL script being used) or one of the IVR-related features (such as Debit Card) to define the location, language, and category of the audio files for the designated application and pass that information to the application.
Table 10 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
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.
Router(config)# call application voice prepaid set-location en 0 tftp://keyer/
Related Commands
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 Reload this designated TCL script. call application voice pin-len Defines the number of characters in the PIN for the application and passes that information to the application. call application voice redirect-number Defines the telephone number to which a call will be redirected--for example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
Syntax Description
application-name The name of the application to which the UID length parameter is being passed. number Defines the number of allowable characters in UIDs associated with the specified application. Valid entries are from 1 to 64.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the 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 11 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
Examples
The following example shows how to configure 4 allowable characters in the UID for the application named prepaid:
Router(config)# call application voice prepaid uid-len 4
Related Commands
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 Reload this designated TCL script. call application voice pin-len Defines the number of characters in the PIN for the application and passes that information to the application. call application voice redirect-number Defines the telephone number to which a call will be redirected--for example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice warning-time Defines the number of seconds a user is warned before their allowed calling time runs out for the designated application.
Command
Description
Syntax Description
application-name The name of the application to which the warning time parameter is being passed. number Defines the number of seconds the user is warned before the allowed calling time runs out. Valid entries are 10 to 600.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(7)T This command was introduced.
Release
Modification
Usage Guidelines
Use this command when configuring IVR (depending on the TCL script being used) or one of the IVR-related features (such as Debit Card) to define the number of seconds a user is warned before the allowed calling time runs out for the specified application and to pass that information to the specified application.
Table 12 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
| TCL Script Name | Description --Summary | Commands to Configure |
|---|---|---|
clid_4digits_npw_3_cli.tcl | This script authenticates the account number and PIN respectively using ANI and null. The length of digits allowed for the account number and password are 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-len call application voice pin-len call application voice retry-count |
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 the CLI. The account number and PIN are collected separately. | call application voice retry-count |
clid_authen_collect_cli.tcl | This script 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
|
clid_col_npw_3_cli.tcl | This script authenticates 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. | call application voice retry-count
|
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
|
clid_t37_fax_onramp.tcl | This script authenticates the account and PIN using the following: prompt-user, ANI, DNIS, gateway ID, redialer ID, and redialer DNIS. | None |
clid_t37_fax_offramp.tcl | This script authenticates the account and PIN using the following: envelope-from, envelope-to, gateway ID, and x-account ID. | None |
clid_t37_fax_rollover.tcl | This script is used for on-ramp T.38 fax rollover to T.37 fax when the destination fax line is busy. The script name is an interim name for Beta. | voice hunt user-busy |
|
Note The two TCL scripts, clid_t37_fax_onramp.tcl and clid_t37_fax_offramp.tcl, have interim names in beta release. |
Examples
The following example shows how to configure a 30-second warning time for the application named prepaid:
Router(config)# call application voice prepaid warning-time 30
Related Commands
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 Reload this 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-len Defines the number of characters in the PIN for the application and passes that information to the application. call application voice redirect-number Defines the telephone number to which a call will be redirected--for example, the operator telephone number of the service provider--for the designated application. call application voice retry-count Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application. call application voice set-location Defines the location, language, and category of the audio files for the designated application and passes that information to the application. call application voice uid-len Defines the number of characters in the UID for the designated application and passes that information to the application.
Command
Description
To specify the interface type to be used for a fax call, use the fax interface-type command in global configuration mode. To return to the default fax protocol, use the no form of this command.
fax interface-type {modem | vfc}
Syntax Description
modem Use a modem card interface for fax calls. vfc Use a Cisco voice feature card (VFC) for fax calls.
Defaults
vfc--if no modem cards are present in the router
modem--if at least one modem card is present in the router
Command Modes
Global configuration
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
If the Cisco AS5300 has only voice feature cards installed, the default interface type for fax calls is vfc. If the router has at least one modem card installed, the default interface type for fax calls is modem.
When using this command to change the interface type for fax calls, you must reload (reboot or reset) the router.
Examples
The following example specifies the use of a VFC interface for fax calls:
Router(config)# fax interface-type vfc Router(config)#
Related Commands
None
To specify the global default fax protocol to be used for all VoIP dial peers, use the fax protocol command in voice-service configuration mode. To return to the default fax protocol, use the no form of this command.
fax protocol {cisco | t38 [ls-redundancy value] [hs-redundancy value]}
Syntax Description
cisco Cisco proprietary fax protocol. t38 ITU-T T.38 standard fax protocol. ls-redundancy value (Optional) Low-speed redundancy for the T.38 fax protocol. The value can be from 0 to 5. The default is 0 (no redundancy). The ls-redundancy parameter refers to data redundancy in the low-speed V.21-based T.30 fax machine protocol. hs-redundancy value (Optional) High-speed redundancy for the T.38 fax protocol. The value can be from 0 to 2. The default is 0 (no redundancy). The hs-redundancy parameter refers to data redundancy in the high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data.
Defaults
cisco
Command Modes
Voice-service configuration
Command History
12.1(3)T This command was introduced on the Cisco 2600 series routers, Cisco 3600 series routers, and Cisco MC3810 concentrators. 12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Use the fax protocol t38 command in voice-service configuration mode to configure T.38 fax relay for all VoIP dial peers. The t38 keyword enables the T.38 standard fax relay protocol. The cisco keyword selects the original Cisco proprietary fax protocol. When the system keyword is selected in the dial-peer version of the fax protocol command, it specifies that the global default fax protocol will be used by that dial peer. The optional parameters ls-redundancy and hs-redundancy are used to send redundant T.38 fax packets when using the T.38 fax protocol.
|
Note The ls-redundancy and hs-redundancy parameters are applicable only to T.38 Fax Relay protocol. |
The ls-redundancy parameter refers to data redundancy in the low-speed V.21-based T.30 fax machine protocol. For the ls-redundancy parameter, the value can be from 0 to 5. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
The hs-redundancy parameter refers to data redundancy in the high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data. For the hs-redundancy parameter, the value can be from 0 to 2. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
|
Note Setting the hs-redundancy parameter greater than 0 will cause a significant increase in the network bandwidth consumed by the fax call. |
Examples
The following example specifies T.38 fax protocol for all VoIP dial peers and sets low-speed redundancy to a factor of 2 and high-speed redundancy to a factor of 1:
Router(config)# voice service voip Router(config-voice-service)# fax protocol t38 ls 2 hs 1
Related Commands
fax protocol (dial-peer) Specifies the fax protocol for a specific VoIP dial peer.
Command
Description
To specify the fax protocol to be used for a specific VoIP dial peer, use the fax protocol command in dial-peer configuration mode. To return to the global default fax protocol, use the fax protocol system command. To disable T.38 fax protocol for a specific dial peer, use the no form of this command.
fax protocol {cisco | t38 [ls-redundancy value] [hs-redundancy value] | system}
Syntax Description
cisco Cisco proprietary fax protocol. t38 ITU-T T.38 standard fax protocol. ls-redundancy value (Optional) Low-speed redundancy for the T.38 fax protocol. The value can be from 0 to 5. The default is 0 (no redundancy). The ls-redundancy parameter refers to data redundancy in the low-speed V.21-based T.30 fax machine protocol. hs-redundancy value (Optional) High-speed redundancy for the T.38 fax protocol. The value can be from 0 to 2. The default is 0 (no redundancy). The hs-redundancy parameter refers to data redundancy in the high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data. system Specifies that the fax protocol for this dial peer will default to the global default fax protocol that has been set using the fax protocol (voice-service) command.
Defaults
system
Command Modes
Dial-peer configuration
Command History
12.1(3)T This command was introduced on the Cisco 2600 series routers, Cisco 3600 series routers, and Cisco MC3810 concentrators. 12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Use the fax protocol t38 command in dial-peer configuration mode to configure T.38 fax relay for a specific dial peer. The t38 keyword enables the T.38 Fax Relay protocol. The cisco keyword selects the original Cisco proprietary fax protocol. When the system keyword is selected, it specifies that the global default fax protocol will be used by that dial peer. The optional parameters ls-redundancy and hs-redundancy are used to send redundant T.38 fax packets when using the T.38 fax protocol.
|
Note The ls-redundancy and hs-redundancy parameters are applicable only to T.38 fax relay protocol. |
The ls-redundancy refers to data redundancy in the low-speed V.21-based T.30 fax machine protocol. For the ls-redundancy, the value can be from 0 to 5. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
The hs-redundancy refers to data redundancy in the high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data. For the hs-redundancy, the value can be from 0 to 2. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
|
Note Setting the hs-redundancy greater than 0 will cause a significant increase in the network bandwidth consumed by the fax call. |
Examples
The following example specifies T.38 fax protocol for VoIP dial peer 99:
Router(config-if)# dial-peer voice 99 voip Router(config-dial-peer)# fax protocol t38
Related Commands
fax protocol (voice-service) Specifies the default fax protocol for all VoIP dial peers.
Command
Description
To establish the rate at which a fax is sent to the specified dial peer, use the fax rate command in dial-peer configuration mode. To reset the dial peer for voice calls, use the no form of the command.
fax rate {12000 | 14400 | 2400| 4800 | 7200 | 9600} [disable | voice] [bytes bytes]
Syntax Description
12000 Specifies a fax transmission speed of 12,000 bits per second (bps). 14400 Specifies a fax transmission speed of 14,400 bps. 2400 Specifies a fax transmission speed of 2400 bps. 4800 Specifies a fax transmission speed of 4800 bps. 7200 Specifies a fax transmission speed of 7200 bps. 9600 Specifies a fax transmission speed of 9600 bps. disable (Optional) Disables fax relay transmission capability. voice (Optional) Specifies the highest possible transmission speed allowed by the voice rate. For example, if the voice codec is G.711, fax transmission may occur up to 14400 bps since 14400 bps is less than the 64k voice rate. If the voice codec is G.729 (8k), the fax transmission speed will be 7200 bps. bytes (Optional) Selects the fax payload size. bytes Number of bytes.
Defaults
voice
Command Modes
Dial-peer configuration
Command History
11.3(1)T This command was introduced as fax-rate command. 12.0(2)XH The fax transmission rate of 12000 was added. 12.0(4)T This command was supported on the Cisco MC3810. 12.1(3)T The command name changed from fax-rate command to fax rate command (non-hyphenated). 12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Use this command to specify the fax transmission rate to the specified dial peer.
The values for this command apply only to the fax transmission speed and do not affect the quality of the fax itself. The higher values provide a faster transmission speed but monopolize a significantly larger portion of the available bandwidth. Slower transmission speeds use less bandwidth.
If the fax rate transmission speed is set higher than the codec rate in the same dial peer, the data sent over the network for fax transmission will be above the bandwidth reserved for Resource Reservation Protocol (RSVP).
|
Note Because a large portion of the available network bandwidth will be monopolized by the fax transmission, Cisco does not recommend setting the fax rate value higher than the value of the selected codec. If the fax rate value is set lower than the codec value, faxes will take longer to send but will use less bandwidth. |
The voice keyword specifies the highest possible transmission speed allowed by the voice rate. For example, if the voice codec is G.711, the fax transmission may occur up to 14400 bps since 14400 bps is less than the 64k voice rate. If the voice codec is G.729 (8k), the fax transmission speed will be 7200 bps.
|
Note If you need to turn off the fax on a dial peer, you can configure the fax rate to 0. This will disable the fax tone detection. |
Examples
The following example shows a fax rate transmission speed of 9600 bps for faxes sent using dial peer 100:
Router(config)# dial-peer voice 100 voip Router(config-dial-peer)# fax rate 9600
The following example sets a fax rate transmission speed of12000 bps and the size of the fax-data frame at 20 bytes for dial peer 100:
Router(config)# dial-peer voice 100 voip
Router(config-dial-peer)# fax rate 12000 bytes 20
Related Commands
codec (dial-peer) Specifies the voice coder rate of speech for a dial peer. fax protocol (dial-peer) Specifies the fax protocol for a specific VoIP dial peer.
Command
Description
To configure fax roll-over from T.38 (fax relay) to T.37 (store and forward fax), use the voice hunt user-busy command in global configuration mode. To return to the default settings, use the no form of this command.
voice hunt user-busySyntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
12.0(5)T This command was introduced.
Release
Modification
Usage Guidelines
This command enables you to specify that, if your T.38 fax relay connection is busy, your fax call will roll over to T.37 store and forward fax connection. This command acts as a switch, either enabling or disabling the roll-over functionality.
To use this command, you need to make sure that there are specific values configured for the ingress VoIP dial peer for T.38 and the on-ramp MMoIP dial peer for T.37. The ingress VoIP dial peer must be configured to have higher preference than the on-ramp MMoIP dial peer. For example, if the preference for the ingress VoIP dial peer is configured as 2, the preference value of the on-ramp MMoIP dial peer must be 3 or greater.
Examples
The following example shows how to configure T.38 to T.37 roll over capabilities:
Router(config)# voice hunt user-busy Router(config)#
To enter the voice-service configuration mode and specify the fax protocol to be used for fax applications, use the voice service global configuration command. To exit the voice-service configuration mode and return to global configuration mode, use the exit command.
voice service voip
Syntax Description
voip Specifies Voice over IP parameters.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.1(1)XA This command was introduced for VoATM on the Cisco MC3810 concentrators. 12.1(2)T This command was introduced on the T train for VoATM on the Cisco MC3810 concentrators. 121(3)T This command was implemented for VoIP on the Cisco 2600 series routers, Cisco 3600 series routers, and Cisco MC3810 concentrators. 12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Usage Guidelines
Use the voice service command to switch to the voice-service configuration mode from the global configuration mode and to specify a voice encapsulation type. Use the exit command to exit the voice-service configuration mode and return to the global configuration mode.
Examples
The following example shows how to access the voice-service configuration mode and specify VoIP parameters, beginning in global configuration mode:
Router(config)# voice service voip Router(config-voice-service)#
Related Commands
modem passthrough Configures modem passthrough over VoIP. fax protocol Specifies the global default fax protocol for all the VoIP dial peers.
Command
Description
This section documents new or modified debug commands for the store and forward fax application using Cisco AS5300 VFCs. All other commands used with this feature are documented in the Store and Forward Fax with ESMTP document and in the Cisco IOS Release 12.0 command references.
To display debug messages for the doc Media Service Provider TIFF or text2Fax engine, use the debug dmsp doc-to-fax EXEC command. To disable the debug messages, use the no form of this command.
debug dmsp doc-to-fax [text-to-fax | tiff-reader]
Syntax Description
text-to-fax Displays debug messages that occur while the DocMSP component is receiving text packets and producing T4 fax data. tiff-reader Displays debug messages that occur while the DocMSP component is receiving TIFF packets and producing T4 fax data.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug dmsp fax-to-do c Displays debug messages for the doc Media Service Provider fax-to-doc TIFF engine.
Command
Description
To display debug messages for doc MSP fax-to-doc, use the debug dmsp fax-to-doc EXEC command. To disable the debug messages, use the no form of this command.
debug dmsp fax-to-doc [tiff-writer]
Syntax Description
tiff-writer Displays debug messages that occur while the DocMSP component is receiving T4 fax data and producing TIFF packets.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug dmsp doc-to-fax Displays debug messages for the doc Media Service Provider TIFF or text2Fax engine.
Command
Description
To display debug messages for FMSP receive, use the debug fmsp receive EXEC command. To disable the debug messages, use the no form of this command.
debug fmsp receive [t30 | t38]
Syntax Description
t30 Specifies T.30 fax protocol. t38 Specifies T.38 fax protocol.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug fmsp send Displays debug messages for FMSP send.
Command
Description
To display debug messages for FMSP send, use the debug fmsp send EXEC command. To disable the debug messages, use the no form of this command.
debug fmsp send [t30 | t38]
Syntax Description
t30 Specifies T.30 fax protocol. t38 Specifies T.38 fax protocol.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug fmsp receive Displays debug messages for FMSP receive.
Command
Description
To display debug messages for off-ramp faxmail, use the debug foip off-ramp EXEC command. To disable the debug messages, use the no form of this command.
debug foip off-rampSyntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug foip on-ramp Displays debug messages for on-ramp faxmail.
Command
Description
To display debug messages for on-ramp faxmail, use the debug foip on-ramp EXEC command. To disable the debug messages, use the no form of this command.
debug foip on-rampSyntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug foip off-ramp Displays debug messages for off-ramp faxmail.
Command
Description
To display debug messages for mail Service Provider Interface receive, use the debug mspi receive EXEC command. To disable the debug messages, use the no form of this command.
debug mspi receiveSyntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug mspi send Displays debug messages for mail SPI send.
Command
Description
To display debug messages for mail Service Provider Interface send, use the debug mspi send EXEC command. To disable the debug messages, use the no form of this command.
debug mspi sendSyntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
12.1(3)XI This command was introduced on the Cisco AS5300 access server.
Release
Modification
Examples
command example
Related Commands
debug mspi receive Displays debug messages for mail SPI receive.
Command
Description
Posted: Mon Aug 7 19:21:00 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.