Login
- Table of Contents
- Related Documents
-
| Title | Size | Download |
|---|---|---|
| 08-Customizable IVR commands | 86.71 KB |
Customizable IVR commands
The following compatibility matrix shows the support of hardware platforms for customizable IVR:
|
Hardware |
Customizable IVR compatibility |
|
MSR810, MSR810-W, MSR810-W-DB, MSR810-LM, MSR810-W-LM, MSR810-10-PoE, MSR810-LM-HK, MSR810-W-LM-HK, MSR810-LMS-EA |
MSR810, MSR810-W, MSR810-W-DB, MSR810-LM, MSR810-W-LM, MSR810-10-PoE, MSR810-LM-HK, MSR810-W-LM-HK: Yes MSR810-LMS-EA: No |
|
MSR810-LMS, MSR810-LUS |
No |
|
MSR2600-6-X1 |
No |
|
MSR2600-10-X1 |
Yes |
|
MSR 2630 |
Yes |
|
MSR3600-28, MSR3600-51 |
Yes |
|
MSR3600-28-SI, MSR3600-51-SI |
No |
|
MSR3600-28-X1, MSR3600-28-X1-DP, MSR3600-51-X1, MSR3600-51-X1-DP |
No |
|
MSR3610-I-DP, MSR3610-IE-DP |
No |
|
MSR3610-X1, MSR3610-X1-DP, MSR3610-X1-DC, MSR3610-X1-DP-DC |
Yes |
|
MSR 3610, MSR 3620, MSR 3620-DP, MSR 3640, MSR 3660 |
Yes |
|
MSR3610-G, MSR3620-G |
No |
To support customizable IVR, some device models require the Voice Software License. For more information, see license management in Fundamentals Configuration Guide.
call-normal
Use call-normal to configure the number match mode for normal secondary calls.
Use undo call-normal to restore the default.
Syntax
call-normal { length number-length | matching | terminator character }
undo call-normal
Default
No number match mode for normal secondary calls exists.
Views
Call node view
Predefined user roles
network-admin
Parameters
length number-length: Specifies the length of called numbers to be matched, in the range of 1 to 31.
matching: Specifies the longest match.
terminator character: Specifies a terminator, a single character that can be a digit 0 through 9, pound sign (#), or asterisk (*).
Usage guidelines
Do not configure a character included in a called number as a terminator.
Examples
# Configure node 1 to match 7-digit called numbers for normal secondary calls.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 call
[Sysname-voice-ivr-node1] call-normal length 7
description
Use description to configure a description for a node.
Use undo description to restore the default.
Syntax
description text
undo description
Default
No description exists.
Views
Call node view
Jump node view
Service node view
Predefined user roles
network-admin
Parameters
text: Specifies a description, a case-sensitive string of 1 to 80 characters.
Examples
# Configure a description of first-node for jump node 1.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 jump
[Sysname-voice-ivr-node1] description first-node
dial-prefix
Use dial-prefix to configure a dial prefix for a call node.
Use undo dial-prefix to restore the default.
Syntax
dial-prefix string
undo dial-prefix
Default
No dial prefix exists.
Views
Call node view
Predefined user roles
network-admin
Parameters
string: Specifies a dial prefix, a string of 1 to 31 characters. Valid characters are digits 0 through 9, pound sign (#), and asterisk (*).
Table 1 Description of characters in the string argument
|
Character |
Description |
|
0-9 |
Digits 0 through 9. |
|
Pound sign (#) or asterisk (*) |
Indicates a valid digit. |
Usage guidelines
After you configure a dial prefix, the device adds the prefix before each called number. If the called number plus the added prefix exceed 31 digits, the device sends only the first 31 digits.
Examples
# Specify 021 as the dial prefix for call node 1.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 call
[Sysname-voice-dial-node1] dial-prefix 021
display voice ivr call-info
Use display voice ivr call-info to display IVR call information.
Syntax
display voice ivr call-info
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display IVR call information.
<Sysname> display voice ivr call-info
Index Called-Number Caller-Number Entity Node-Id Status
-------------------------------------------------------------------------
1 101 100 101 1 PLAY MEDIA
2 406 200 201 3 WAIT INPUT
3 606 300 301 6 CALL
4 806 400 401 9 IDLE
Table 2 Command output
|
Field |
Description |
|
Index |
Index of the call information. |
|
Entity |
IVR entity number for the called number. |
|
Node-Id |
ID of the node that is being executed. |
|
Status |
Current status: · IDLE—The node is idle. · PLAY MEDIA—The node is playing a media file. · WAIT INPUT—The node is waiting for user input. · CALL—The node is calling a number. |
display voice media-play
Use display voice media-play to display playing information.
Syntax
display voice media-play
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display playing information.
<Sysname> display voice media-play
Index Codec Media-Id Play-Times Status Type
--------------------------------------------------------------------------
1 g729r8 1001 3 play PSTN:1/0
2 g711alaw 1002 2 stop IP:100.1.1.1
3 g711ulaw 1003 2 stop IP:100.1.1.1
4 g723r53 1004 2 stop IP:100.1.1.1
Table 3 Command output
|
Description |
|
|
Index |
Index of the playing information. |
|
Codec |
Codec type of the played media file: · g711alaw. · g711ulaw. · g723r53. · g729r8. |
|
Media-Id |
ID of the played media file. |
|
Play-Times |
Number of times that the media file is to be played. |
|
Status |
Current status of the media file: · play—The media file is being played. · stop—The media file is not played. |
|
Type |
Current call type: · PSTN—The call is from the PSTN side. In the above example, PSTN:1/0 indicates that the call came in from the voice interface 1/0. · IP—The call is from the IP side. |
display voice media-source
Use display voice media-source to display media file information.
Syntax
display voice media-source
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display media file information.
<Sysname> display voice media-source
Codec Media-Id source Size (Bytes) Read-Num Cache-Num
--------------------------------------------------------------------------
g729r8 1000 cfa0:/wav/g7 69304 1 1
29r8/0.wav
Table 4 Command output
|
Field |
Description |
|
Codec |
Codec type of the media file. |
|
Media-Id |
ID of the media file. |
|
Source |
Name and location of the media file. |
|
Size (Bytes) |
Size of the media file in bytes. |
|
Read-Number |
Number of the read control block for the media file. |
|
Cache-Number |
Number of the cache for the media file. |
global-input-error
Use global-input-error to configure a global policy for handling input errors.
Use undo global-input-error to restore the default.
Syntax
global-input-error { media-play media-id [ play-times ] | repeat repeat-times } *
undo global-input-error
Default
The system does not play voice prompts for input errors and terminates the call after three times of input errors.
Views
IVR management view
Predefined user roles
network-admin
Parameters
media-play media-id: Specifies a media file by its ID in the range of 0 to 2147483647. A node plays the specified media file when an input error occurs.
play-times: Specifies the number of times for playing the media file, in the range of 1 to 255. The default is 1.
repeat repeat-times: Specifies the maximum number of input errors allowed, in the range of 0 to 255. The default is 3. After an input error occurs, the system executes the node again. When the maximum number of input errors are reached, the system terminates the call.
Examples
# Configure a global policy for handling input errors as follows:
· The media file with ID 10002 is played after an input error occurs.
· The media file is played twice.
· The call is terminated after five times of input errors.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] global-input-error media-play 10002 2 repeat 5
Related commands
input-error
global-timeout
Use global-timeout to configure a global policy for handling input timeouts.
Use undo global-timeout to restore the default.
Syntax
global-timeout { expires seconds| media-play media-id [ play-times ] | repeat repeat-times } *
undo global-timeout
Default
The timeout time is 10 seconds. The system does not play voice prompts for input timeouts and terminates the call after three times of input timeouts.
Views
IVR management view
Predefined user roles
network-admin
Parameters
expires seconds: Specifies the timeout time in the range of 1 to 255 seconds.
media-play media-id: Specifies a media file to be played after an input timeout occurs. The media-id argument represents the ID of the media file, in the range of 0 to 2147483647.
play-times: Specifies the number of times for playing the media file, in the range of 1 to 255. The default is 1.
repeat repeat-times: Specifies the maximum number of input timeouts allowed, in the range of 0 to 255. After an input timeout occurs, the system executes the node again. When the maximum number of input timeouts are reached, the system terminates the call.
Examples
# Configure a global policy for handling input timeouts as follows:
· The timeout time is 20 seconds.
· The media file with ID 100001 is played.
· The media file is played once.
· The call is terminated after two times of input timeouts.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] global-timeout expires 20 media-play 100001 1 repeat 2
Related commands
timeout
input extension
Use input extension to configure an extension secondary call for a node.
Use undo input to delete the configuration of an extension secondary call.
Syntax
input number extension extension-number
undo input number
Default
No extension secondary calls exist.
Views
Call node view
Predefined user roles
network-admin
Parameters
number: Specifies an input number, a string of 1 to 31 characters that can include digits 0 through 9, pound sign (#), and asterisk (*).
extension-number: Specifies the extension number, a string of 1 to 31 characters that can include digits 0 through 9, pound sign (#), and asterisk (*).
Usage guidelines
You can configure a maximum of 10 extension secondary calls for a call node.
Examples
# Configure node 1 to execute an extension secondary call to the number 5000 when the subscriber dials the number 0.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 call
[Sysname-voice-ivr-node1] extension 0 call 5000
input-error
Use input-error to configure an input error handling policy for a node.
Use undo input-error to restore the default.
Syntax
input-error { end-call | goto-pre-node | goto-node node-id } [ media-play media-id [ play-times ] | repeat repeat-times ] *
undo input-error
Default
The global input error handling policy is used.
Views
Call node view
Jump node view
Predefined user roles
network-admin
Parameters
end-call: Terminates the call when the maximum number of input errors are reached.
goto-pre-node: Returns to the previous node when the maximum number of input errors are reached.
goto-node node-id: Jumps to a node specified by its ID when the maximum number of input errors are reached. The value range for the node-id argument is 1 to 256.
media-play media-id: Plays a media file specified by its ID when an input error occurs. The value range for the media-id argument is 0 to 2147483647.
play-times: Specifies the number of times for playing a media file, in the range of 1 to 255. The default is 1.
repeat repeat-times: Specifies the maximum number of input errors allowed. After an input error occurs, the system executes the node again. When the maximum number of input errors are reached, the system executes the configured action. The value range for the repeat-times argument is 0 to 255, and the default is 3.
Examples
# Configure an input error handling policy for Jump node 1 as follows:
· The media file with ID 10002 is played when an input error occurs.
· The media file is played twice.
· The call is terminated after five times of input errors.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 jump
[Sysname-voice-ivr-node1] input-error end-call media-play 10002 2 repeat 5
ivr-root
Use ivr-root to specify the root node (the first node to be executed) of an IVR entity.
Use undo ivr-root to restore the default.
Syntax
ivr-root node-id
undo ivr-root
Default
No root node is configured for an IVR voice entity.
Views
IVR entity view
Predefined user roles
network-admin
Parameters
node-id: Specifies the ID of the root node, in the range 1 to 256.
Examples
# Specify node 1 as the root node of IVR entity 100.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] dial-program
[Sysname-voice-dial] entity 100 ivr
[Sysname-voice-dial-entity100] ivr-root 1
ivr-system
Use ivr-system to enter IVR management view.
Use undo ivr-system to delete all IVR settings in IVR management view and exit the view.
Syntax
ivr-system
undo ivr-system
Default
No IVR management view exists.
Views
Voice view
Predefined user roles
network-admin
Examples
# Enter IVR management view.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr]
media-file
Use media-file to enter media resource management view.
Syntax
media-file { g711alaw | g711ulaw | g723r53 | g729r8 }
Views
Voice view
Predefined user roles
network-admin
Parameters
g711alaw: Enters g711alaw codec view.
g711ulaw: Enters g711ulaw codec view.
g723r53: Enters g723r53 codec view.
g729r8: Enters g729r8 codec view.
Examples
# Enter g729r8 codec view.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] media-file g729r8
[Sysname-voice-media-g729r8]
media-play
Use media-play to specify the media file to be played when a node is waiting for user input.
Use undo media-play to restore the default.
Syntax
media-play media-id [ play-times ] [ force ]
undo media-play
Default
No media file is played when a node is waiting for user input.
Views
Call node view
Jump node view
Predefined user roles
network-admin
Parameters
media-id: Specifies a media file by its ID in the range of 0 to 2147483647.
play-times: Specifies the number of times for playing the media file, in the range of 1 to 255. The default is 1.
force: Specifies that user input is valid only after the play of the media file ends. If you do not specify this keyword, user input is valid when the media file is played.
Examples
# Configure jump node 1 to play media file 10000 three times when waiting for user input and to accept user input after the play of the media file ends.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 jump
[Sysname-voice-ivr-node1] media-play 10000 3 force
node
Use node to create an IVR node and enter its view, or enter the view of an existing IVR node.
Use undo node to delete IVR nodes.
Syntax
node node-id [ call | jump | service ]
undo node { node-id | all }
Default
No IVR nodes exist.
Views
IVR management view
Predefined user roles
network-admin
Parameters
node-id: Specifies the node ID in the range 1 to 256.
call: Creates a call node, which executes a secondary call after the subscriber enters a number.
jump: Creates a jump node, which jumps to another node according to user input.
service: Creates a service node, which executes various operations, such as executing an immediate secondary call, jumping, terminating a call, and playing a media file.
all: Specifies all types of nodes.
Examples
# Create Jump node 1 and enter its view.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 jump
[Sysname-voice-ivr-node1]
operation
Use operation to configure an operation for a service node.
Use undo operation to delete the configuration of the operation for a service node.
Syntax
operation number { call-immediate call-number | end-call | goto-node node-id | goto-pre-node | media-play media-id [ play-times ] }
undo operation number
Default
No operations are configured.
Views
Service node view
Predefined user roles
network-admin
Parameters
number: Specifies the number of the configured operation, in the range 1 to 3.
call-immediate call-number: Executes an immediate secondary call. The call-number argument represents the extension number of the secondary call and can include digits 0 through 9, pound sign (#), and asterisk (*).
end-call: Terminates a call.
goto-node node-id: Jumps to a node specified by its ID in the range of 1 to 256.
goto-pre-node: Returns to the previous node.
media-play media-id: Plays a media file specified by its ID in the range of 0 to 2147483647.
play-times: Specifies the number of times for playing the media file, in the range of 1 to 255. The default is 1.
Examples
# Configure service node 1 to end a call.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 service
[Sysname-voice-ivr-node1] operation 1 end-call
select-rule
select-rule
Use select-rule to specify the execution order of configured operations for a service node.
Use undo select-rule to restore the default.
Syntax
select-rule 1st-operation 2nd-operation 3rd-operation
undo select-rule
Default
The execution order is 1 > 2 > 3.
Views
Service node view
Predefined user roles
network-admin
Parameters
1st-operation: Specifies the number of the operation to be executed first, in the range of 1 to 3.
2nd-operation: Specifies the number of the operation to be executed secondly, in the range of 1 to 3. The value for this argument cannot be the same as the value for 1st-operation.
3rd-operation: Specifies the number of the operation to be executed thirdly, in the range of 1 to 3. The value for this argument cannot be the same as the values for 1st-operation and 2nd-operation.
Usage guidelines
After a service node jumps to another node, returns to the previous node, or terminates a call, it does not execute the remaining operations.
Examples
# Specify the execution order of configured operations for node 1 as 1 > 3 > 2.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 service
[Sysname-voice-ivr-node1] select-rule 1 3 2
operation
set-media
Use set-media to specify an ID for a media file.
Use undo set-media to delete IDs for media files.
Syntax
set-media media-id file filename
undo set-media { media-id | all }
Default
No ID is specified for a media file.
Views
Media resource management view
Predefined user roles
network-admin
Parameters
media-id: Specifies an ID in the range 0 to 2147483647.
file filename: Specifies a media file by its name.
all: Specifies all media file IDs.
Examples
# Specify ID 10001 for the media file cfa0:/g729/ring.wav.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] media-file g729r8
[Sysname-voice-media-g729r8] set-media 10001 file cfa0:/g729/ring.wav
timeout
Use timeout to configure an input timeout handling policy for a node.
Use undo timeout to restore the default.
Syntax
timeout { end-call | goto-pre-node | goto-node node-id } [ expires seconds | media-play media-id [ play-times ] | repeat repeat-times ] *
undo timeout
Default
The global input timeout handling policy is used.
Views
Call node view
Jump node view
Predefined user roles
network-admin
Parameters
expires seconds: Specifies the timeout time in the range of 1 to 255 seconds. The default is 10 seconds.
end-call: Terminates a call when the maximum number of input timeouts are reached.
goto-pre-node: Returns to the previous node when the maximum number of input timeouts are reached.
goto-node node-id: Jumps to a node specified by its ID when the maximum number of input timeouts are reached. The value range for the node-id argument is 1 to 256.
media-play media-id: Plays a media file specified by its ID when an input timeout occurs. The value range for the media-id argument is 0 to 2147483647.
play-times: Specifies the number of times for playing a media file, in the range of 1 to 255. The default is 1.
repeat repeat-times: Specifies the maximum number of input timeouts allowed. After an input timeout occurs, the system executes the node again. When the maximum number of input timeouts are reached, the system executes the configured action. The value range for the repeat-times argument is 0 to 255, and the default is 3.
Examples
# Configure Jump node to terminate a call after three times of input timeouts.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 jump
[Sysname-voice-ivr-node1] timeout end-call repeat 3
user-input
Use user-input to configure a jump operation for an input character.
Use undo user-input to delete the jump operation for an input character.
Syntax
user-input character { end-call | goto-node node-id | goto-pre-node }
undo user-input character
Default
No jump operation is configured for a character.
Views
Jump node view
Predefined user roles
network-admin
Parameters
character: Specifies a character, which can be any of digits 0 through 9, pound sign (#), or asterisk (*).
end-call: Terminates a call.
goto-node node-id: Jumps to a node specified by its ID in the range of 1 to 256.
goto-pre-node: Returns to the previous node.
Usage guidelines
You can configure a maximum of 12 jump operations for a jump node.
Examples
# Configure the node to terminate the call if the subscriber presses 0.
<Sysname> system-view
[Sysname] voice-setup
[Sysname-voice] ivr-system
[Sysname-voice-ivr] node 1 jump
[Sysname-voice-ivr-node1] user-input 0 end-call
