|
Genesys 8.1 SCXML Technical Reference |
||
< Functions Action Elements > |
We will have parameter elements for the following action elements to be used as input attributes.
<collect>
<play>
<playandcollect>
<playandverify>
<runtreatments>
This is the top-level element which defines the set of prompts which are to be used under certain conditions associated with the treatment dialog.
Name |
Required |
Type |
Default Value |
Valid Values |
Description |
---|---|---|---|---|---|
type |
false |
NMTOKEN |
ann |
tts, ann, iretry, ifailure, isuccess, itimeout, MSG_type |
This specifies the type of condition that these prompts will be used for:
|
<prompt>
— Occurs 1 to 10 times. Each instance defines a given announcement to be played to the caller.This defines a given announcement to play to a caller.
Name |
Required |
Type |
Default Value |
Valid Values |
Description |
---|---|---|---|---|---|
intid |
false |
value expression |
none |
Any expression that returns a valid integer |
This represents an integer ID for the announcement. This is mutually exclusive with the following attributes:
Note: if associated with the See SCXML Legal Data Values and Value Expressions for details. |
number |
false |
value expression |
none |
Any expression that returns a valid string |
This represents the number to announce. The first digit defines how the number should be announced:
This is mutually exclusive with the following attributes:
See SCXML Legal Data Values and Value Expressions for details. |
userannid |
false |
value expression |
none |
Any expression that returns a valid string |
This represents the user announcement ID as returned after a successful recording of a user announcement request. This is mutually exclusive with the following attributes:
See SCXML Legal Data Values and Value Expressions for details. |
text |
false |
value expression |
none |
Any expression that returns a valid string |
This represents the ASCII text to be announced using text-to-speech technology (if supported by the IP equipment). This is mutually exclusive with the following attributes:
Note: if associated with the See SCXML Legal Data Values and Value Expressions for details. |
interrupt |
false |
boolean expression |
true |
Any expression that returns a boolean (true, false) |
This indicates whether the caller can interrupt the announcement. See SCXML Conditional Expressions for details. |
None
This is the top-level element which defines the characteristics needed to collect digits from a caller in association with the treatment dialog.
Name |
Required |
Type |
Default Value |
Valid Values |
Description |
---|---|---|---|---|---|
max_digits |
false |
value expression |
none |
Any expression that returns a valid string |
The maximum number of digits to be collected (up to 31). Note: max_digits may be equal to 0. In this case, no time is spent waiting for caller input digits, and a response is returned indicating 0 digits were collected. See SCXML Legal Data Values and Value Expressions for details. |
abort_digits |
false |
value expression |
none |
Any expression that returns a valid string |
This sequence of up to two keys aborts the digit-collection operation. If this sequence appears, the intelligent peripheral considers this to be a failed digit-collection attempt. See SCXML Legal Data Values and Value Expressions for details. |
ignore_digits |
false |
value expression |
none |
Any expression that returns a valid string |
This sequence of up to two keys is treated as though the keys have not been pressed. See SCXML Legal Data Values and Value Expressions for details. |
backspace_digits |
false |
value expression |
none |
Any expression that returns a valid string |
This sequence of up to two keys causes the previous keystroke to be discarded. See SCXML Legal Data Values and Value Expressions for details. |
term_digits |
false |
value expression |
none |
Any expression that returns a valid string |
This sequence of up to two keys causes all the digits, not including the term_digits, to be returned to the service logic as collected digits. See SCXML Legal Data Values and Value Expressions for details. |
reset_digits |
false |
value expression |
none |
Any expression that returns a valid string |
This sequence of up to two keys causes all the previous keystrokes to be discarded. The digit collection resumes. See SCXML Legal Data Values and Value Expressions for details. |
clear |
false |
boolean |
false |
true, false |
Indicates whether any information that has been input should be cleared before digit collection starts. Not supported in GR-1129-CORE protocol implementation. |
start_timeout |
false |
value expression |
none |
Any expression that returns a valid integer |
The number of seconds the resource should wait for the caller to begin DTMF input. See SCXML Legal Data Values and Value Expressions for details. |
digit_timeout |
false |
value expression |
none |
Any expression that returns a valid integer |
The number of seconds the resource should wait between DTMF digits. See SCXML Legal Data Values and Value Expressions for details. |
total_timeout |
false |
value expression |
none |
Any expression that returns a valid integer |
The total number of seconds the resource should wait for the caller to provide the requested DTMF input See SCXML Legal Data Values and Value Expressions for details. |
None
This defines what needs to be compared to the digits collected from the caller.
Name |
Required |
Type |
Default Value |
Valid Values |
Description |
---|---|---|---|---|---|
digits |
false |
value expression |
none |
Any expression that returns a valid string |
This represents the actual digits the caller input should be compared against. This is mutually exclusive with the following attributes:
See SCXML Legal Data Values and Value Expressions for details. |
userid |
false |
value expression |
none |
Any expression that returns a valid string |
This represents the user ID string that the resource should use to index into a local table for verification. This is mutually exclusive with the following attributes:
See SCXML Legal Data Values and Value Expressions for details. |
planid |
false |
value expression |
none |
Any expression that returns a valid string |
This represents an index into a resource's table of dialing plans. The input is checked for general format compliance with the dialing plan selected by this ID. This is mutually exclusive with the following attributes:
See SCXML Legal Data Values and Value Expressions for details. |
attempts |
false |
value expression |
0 |
Any expression that returns a valid integer |
This indicates the number of attempts the caller is allowed to make before failing the verification. See SCXML Legal Data Values and Value Expressions for details. |
None
This is the top-level element which defines the duration of a pause to be used between dialog treatments for the <runtreatments>
element.
Name |
Required |
Type |
Default Value |
Valid Values |
Description |
---|---|---|---|---|---|
duration |
false |
value expression |
"0" |
Any expression that returns a valid integer |
A value expression which returns the duration in seconds that the treatment processing should pause. See SCXML Legal Data Values and Value Expressions for details. |
None
|
Genesys 8.1 SCXML Technical Reference |
||
< Functions Action Elements > |