Attempt Terminate
Attempt Terminate
The AttemptTerminate
attempts to connect the caller to one or more B-Party Destination
Addresses (destinations).
If multiple destinations are specified, the operation will try them all in sequence until one of these destinations answers the call.
- If the call successfully terminates to a destination, then the call processing is over and no further operations will be processed.
- If the caller abandons the call (i.e. hangs up) then the call processing is over and no further operations will be processed.
The AttemptTerminate
operation has one, two, or three exits.
Config Parameters
The AttemptTerminate
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
destinations
|
Array of Object |
[Required] The destinations Array must contain one or more Objects.
|
Config Rules
An AttemptTerminate
operation destinations
Object is as follows.
Parameter | Type | Description |
---|---|---|
address
|
String |
The destination address to which to connect. This must have a length of at least one destination
digit, and must contain only the characters 0 -9 or A -F .
|
timeout_seconds
|
Integer | The number of seconds for which the destination address should be rung before deciding that the call is unanswered and proceeding to the Busy/NoAnswer exit. If there is no processing attached to the Busy/NoAnswer exit, then this timeout value will not be used. If present, this value must be greater than or equal to zero. If absent or if zero, then a system-configured default timeout will be used. |
Example Operation
Here is an example AttemptTerminate
operation in JSON representation.
{
"id": 5,
"type": "AttemptTerminate",
"base_node": 1,
"config": {
"rules": [
{ "address": "0211324543", "timeout_seconds": 15 },
{ "address": "0220934829" }
]
},
"exits": [ 4 ]
}
In this example, the destination address 0211324543
will be attempted for 15
seconds, and if not
answered then the destination address 0220934829
will be attempted for the system-configured default
number of seconds.
Exits
There are three separate Exit case scenarios for the AttemptTerminate operation.
The simplest is the one-exit case, which should be the default form of this operation when creating new instances in the Flow Editor GUI:
Exit Index | Name | Description |
---|---|---|
0
|
Busy/NoAnswer | [Required] This exit is followed if none of the listed destination addresses Answer. |
The two-exit case allows separate routing for Busy vs. No Answer on the final termination address in the list.
Exit Index | Name | Description |
---|---|---|
0
|
Busy | This exit is followed if the final (or only) destination address returns Busy. |
1
|
NoAnswer | This exit is followed if the final (or only) destination address returns NoAnswer. This exit is also used in the case that the final (or only) destination address is not known to the switch, i.e. Route Selection Failure occurs on the final termination attempt. However, RSF is an exceptional case, and the Flow Editor GUI may decide not to identify this RSF handling explicitly to the user. |
The three-exit case allows separate routing for Busy vs. No Answer vs. Route Selection Failure on the final termination address in the list.
Special routing for Route Selection Failure is a “special case” handling which is probably not a feature which will be of interest to most users. In general, users should only be interested in the one-exit or two-exit forms of this node.
The Flow Editor GUI may decide not to provide the three-exit form of this node (except where a node already has three exits when loaded from the database).
Exit Index | Name | Description |
---|---|---|
0
|
Busy | This exit is followed if the final (or only) destination address returns Busy. |
1
|
NoAnswer | This exit is followed if the final (or only) destination address returns NoAnswer. |
2
|
RSF | This exit is followed if the final (or only) destination address is not known to the switch — i.e. Route Selection Failure occurs on the final termination attempt. |