No Custom Parameters
GatherDigits instructs the media engine to watch for DTMF digits on a connection.
GatherDigits allows one to determine which digits were pushed.
The termination condition parameters on the action are a means to create a matrix of reasons that the action should stop successfully.
one can use
to determine why the command stopped gathering digits.
The media engine is continuously buffering observed digits for any given connection.
GatherDigits considers any digits stored in this digit buffer at the onset of the action for the processing of any specified termination conditions. Once the
GatherDigits action has started executing, digits that occur in real-time also fill up the buffer and so can cause the specified termination conditions to be met. For example, if the user pushes
123, and then a
GatherDigits operation is executed with a
1234 specified, the
GatherDigits_Complete event will occur as soon as the user pushes
4. After the
GatherDigits_Complete event is fired, the buffer is cleared of all digits.
GatherDigits to a connection or a conference results in a voice resource being utilized until the action results in the
If a connection is specified as the recepient of the
GatherDigits, the voice resource attaches to the connection. If a conference is specified as the recepient of the
GatherDigits, a new connection (which uses a conference resource) is created and added to the conference for the duration of the
GatherDigits, and the voice resource is attached to that new connection. It is important to understand this behavior, as the
ConnectionId result data will always be the connection to which the
GatherDigits voice resource is attached. In other words, in the case of a
GatherDigits to a connection, the value of the
ConnectionId result data is the same as that specified as an action parameter. In the case of a
GatherDigits to a conference, the value of the
ConnectionId result data is the value of the new connection added to conference which is only a valid value for the duration of the
GatherDigits. In either case, this result data
ConnectionId is what one would later specify in
|Parameter Name||.NET Type||Default||Description|
|CommandTimeout||Indicates a command timeout value (in milliseconds).
If this condition is met, the |
|ConnectionId *||Indicates the connection to |
|TermCondMaxTime||The amount of time (in milliseconds) that can elapse before terminating the |
|TermCondMaxDigits||The number of digits that will cause the |
|TermCondDigit||A specific digit that will cause the |
|TermCondDigitList||A list of digits that will cause the |
|TermCondDigitPattern||A specific sequence of digits that will cause the |
|TermCondInterDigitDelay||The amount of time between digits which will cause the |
|State||Optional user state information which is guaranteed present as the State event parameter in
|Parameter Name||.NET Type||Description|
|ConnectionId||The value of the |
|ResultCode||A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.|
|OperationId||A unique identifier to this |