☰
Navigation :

Attempt Terminate

Attempt Terminate

The AttemptTerminate operation attempts to connect the caller to a B-Party destination address. If multiple destinations are specified, the operation will try them in sequence until one of the destinations answers the call or all destinations have been tried.

If the call successfully terminates to a destination or the caller abandons the call (i.e. hangs up), no further processing is performed and no exit is followed. Otherwise the exit associated with the final termination attempt result will be selected.

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 Destinations

The attributes for each AttemptTerminate operation destinations Object are as follows.

Parameter Type Description
address Telephony Digits [Required] The destination address to attempt termination to. This must not be empty.
timeout_seconds Integer The number of seconds that the termination attempt to the destination should allow for ringing before trying the next destination (or selecting the no-answer exit) if the destination does not answer. If present, this value must be greater than or equal to zero. If absent, a system-configured default timeout will be used. The default timeout may vary for the last destination.

Example Operation

Here is an example AttemptTerminate operation in JSON representation.

    {
        "id": 5,
        "type": "AttemptTerminate",
        "config": {
            "rules": [
                { "address": "0211324543", "timeout_seconds": 15 },
                { "address": "0220934829" }
            ]
        },
        "exits": [ 4 ]
    }

In this example, termination will first be attempted to destination address 0211324543. If the destination is valid and not busy, the destination will be allowed to ring for up to 15 seconds. If the destination does not answer, the second destination - 0220934829 - will be attempted with the system-configured default timeout. If both destinations are invalid, busy, and/or do not answer, and the caller is still connected, processing will continue via exit index 0 to the operation with ID 4.

Exits

This operation may be configured with either 1, 2, or 3 exits.

The simplest is the one-exit configuration:

Exit Index Name Description
0 Busy / No Answer / No Such Number [Required] This exit is followed if:
  • All termination attempts result in Busy or No Such Number responses, or are not answered, and
  • The caller is still connected.

In the two-exit configuration:

Exit Index Name Description
0 Busy This exit is followed if:
  • All termination attempts result in Busy or No Such Number responses, or are not answered, and
  • The result of the termination attempt to the last (or only) destination is Busy, and
  • The caller is still connected.
1 No Answer / No Such Number This exit is followed if:
  • All termination attempts result in Busy or No Such Number responses, or are not answered, and
  • The result of the termination attempt to the last (or only) destination is No Such Number, or is not answered, and
  • The caller is still connected.

In the three-exit configuration:

Exit Index Name Description
0 Busy This exit is followed if:
  • All termination attempts result in Busy or No Such Number responses, or are not answered, and
  • The termination attempt to the last (or only) destination results in a Busy response, and
  • The caller is still connected.
1 No Answer This exit is followed if:
  • All termination attempts result in Busy or No Such Number responses, or are not answered, and
  • The termination attempt to the last (or only) destination is not answered, and
  • The caller is still connected.
2 No Such Number This exit is followed if:
  • All termination attempts result in Busy or No Such Number responses, or are not answered, and
  • The termination attempt to the last (or only) destination results in a No Such Number response, and
  • The caller is still connected.