Outgoing call component

Table of Contents

Description

Calls the subscriber by number and transfers trunk control to the script IVR.

Table 1. System Characteristics

Index

126

Short title

dial

Types of scenarios

All of them

Starter module

r_script_component_dial

Mode

Asynchronous

Icon

126

Branching pattern

Branching, closing

Properties

Table 2. Properties
Specification Description

Title: Mode
Code: mode
Visibility: no
Default: `Asynchronous'

The mode of operation of the component after sending an outgoing call request to the selected server IVR.
Possible options:

  • Asynchronous (async, 0) - Control is immediately passed to the next component.

  • Wait for Preanswer (1xx) (wait_preanswer, 1) - Waiting for sending INVITE and receiving SIP reply 1xx.

  • Wait for final response (2xx-6xx) (wait_finanswer, 2) - Waiting for sending INVITE and receiving final SIP response: successful (2xx) or unsuccessful (4xx-6xx).

  • Wait for IVR stop (wait_ivr_stopped, 3) - Waiting for call processing to complete and script to end IVR.

Title: Number
Code: num
Visibility: no
Default: — 

Caller ID.
The standard routing call process is applied.

Title: Outgoing Number
Code: callerId
Visibility: no
Default: — 

The initiator number to be substituted as username in the From header of the SIP request being sent INVITE.
Mandatory to be specified. Used in the call routing process.

Title: `The Descending Name
Code: callerName
Visibility: no
Default: — 

The initiator name to be substituted as the displayname in the From header of the SIP request to be sent INVITE.
If no value is specified, the URI does not contain a displayname.

Title: Additional Titles
Code: headers
Visibility: no
Default: — 

Additional headers to be inserted into the SIP request. The argument contains a multiline value, the format of each of the lines: HeaderName: HeaderValue.
Used to add new custom headers, the values of standard headers cannot be changed in most cases.

Title: Script Source
Code: ivrScriptMode
Visibility: no
Default: `From list'

Possible options:

  • From list (code_sel, 2) - Selects a script from the drop-down list.

  • IVR Script Code (code, 1) - Specifies the script code from the argument.

  • JSON IVR script (json, 0) - Specifies the script body from the argument.

Title: The Body of the Script
Code: ivrScriptJson
Visibility: yes
Default: — 

An argument containing a JSON structure with the IVR script body (packed in a JSON array string).
The format of the structure is similar to the scriptdata.objects section in the IVR script entity.

Title: Scenario Code
Code: ivrScriptCode
Visibility: yes
Default: — 

Argument with the IVR script code in the current domain.

Title: Scenario
Code: ivrScriptCodeSel
Visibility: no
Default: — 

Drop-down list with script codes. Contains all available (non-hidden) IVR scripts contained in the current domain.

Title: Scenario Variables
Code: ivrScriptVars
Visibility: yes
Default: — 

An argument containing a JSON structure with script variables (packed in a JSON array string).
The format of the structure is similar to the scriptdata.variables section in the IVR script entity.
Applies when specifying the body of the script as JSON.

Title: Variable Values
Code: ivrScriptVarValuesT
Visibility: no
Default: — 

Table of initial values for the local variables of the IVR script run to serve the initiated call.

Keys - names of scenario variables IVR.
Matching is done by variable names, values are assigned only to those variables defined in the script.

If the running IVR script passes control to a nested script, then assignment of values to each of these variables is performed no more than once, but may be delayed until the loading of the nested script, which has a variable with the corresponding name.

The values set in this way are prioritized over the default values within the scenario IVR.

Title: Parameter 1
Code: param1
Visibility: yes
Default: — 

The first parameter for the initiated IVR script. The value is accessed via the startparam(1) expression function or by storing the value in the component Start.

Title: Parameter 2
Code: param2
Visibility: yes
Default: — 

The second parameter for the initiated IVR script. The value is accessed through the expression function startparam(2).

Title: Parameter 3
Code: param3
Visibility: yes
Default: — 

The third parameter for the initiated IVR script The value is accessed through the expressions function startparam(3).

Title: Parameter 4
Code: param4
Visibility: yes
Default: — 

The fourth parameter for the initiated IVR script. The value is accessed through the expression function startparam(4).

Title: Parameter 5
Code: param5
Visibility: yes
Default: — 

The fifth parameter for the initiated IVR script. The value is accessed through the expression function startparam(5).

Title: Other Parameters
Code: paramsOther
Visibility: yes
Default: — 

JSON array containing parameters 6, 7, 8, etc. for the IVR script to be initiated. The value is accessed through the startparam(N) expression function, where N > 6.

Title: Time, s
Code: callTimeout
Visibility: yes
Default: — 

Limit time to wait for final caller response, in seconds.

Title: SIP response code to variable
Code: sipCode
Visibility: yes
Default: — 

Variable to store the last received SIP reply code (1xx-6xx).
When waiting for a preliminary SIP reply, either a preliminary reply (1xx) or a final reply will appear there (2xx-6xx)

Title: Transition
Code: transfer
Visibility: no
Default: — 

The component to which control is passed if the operation is successfully completed.

Title: Transition, Failure
Code: transferFail
Visibility: no
Default: — 

Component to which control is transferred in case of receiving an unsuccessful final SIP response (4xx-6xx).
If not filled in, the transition is carried out on the standard branch.

Title: Transition, no answer
Code: transferNoAnswer
Visibility: no
Default: — 

The component to which control is passed when the time to wait for a final SIP response in the final and scenario completion standby modes, or a preliminary response in the preliminary response standby mode, has expired.
If not filled in, the transition is carried out on the standard branch.

Title: Transition, Error
Code: transferError
Visibility: no
Default: — 

The component to which control is passed if any error occurs during the call initiation process.
If not filled in, the transition is carried out on the standard branch.

See also