Outgoing call component

:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:

Description

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

Table 1. System characteristics

Index

126

Short name

dial

Script types

All

Start module

r_script_component_dial

Mode

Asynchronous

Icon

126

Branching type

Branching, closing

Properties

Table 2. Properties
Specification Description

Name: Mode

Code: mode

Visibility condition: no

Default: Asynchronous

The operating mode of the component after sending a request for an outgoing call to the selected IVR server.

Possible options:

  • Asynchronous (async, 0) – Control is immediately transferred to the next component.

  • Wait for preliminary response (1xx) (wait_preanswer, 1) – Waiting for sending INVITE and receiving SIP response 1xx.

  • Wait for final response (2xx-6xx) (wait_finanswer, 2) – Waiting for the INVITE to be sent and the final SIP response to be received: successful (2xx) or unsuccessful (4xx-6xx).

  • Wait for IVR to stop (wait_ivr_stopped, 3) – Wait for the call to be processed and the IVR script to complete.

Name: Number

Code: num

Visibility condition: no Default: — 

Subscriber number.

The standard routing call process applies.

Name: Outgoing number

Code: callerId

Visibility condition: no

Default: — 

Initiator number, inserted as username in the From header of the sent SIP INVITE request. Mandatory to indicate. Used during call routing.

Name: Outgoing name

Code: callerName

Visibility condition: no

Default: — 

Initiator name, substituted as displayname in the From header of the sent SIP INVITE request.

If no value is specified, then the URI does not contain a displayname.

Name: Additional headers

Code: headers

Visibility condition: no

Default: — 

Additional headers inserted into the SIP request. The argument contains a multi-line value, the format of each line is HeaderName: HeaderValue.

Used to add new custom headers, the default header values cannot be changed in most cases.

Name: Script Source Code: ivrScriptMode Visibility condition: no

Default: From the list

Possible options:

  • From list (code_sel, 2) – Select a scenario from the drop-down list.

  • IVR script code (code, 1) – Specify the script code from the argument.

  • IVR script JSON (json, 0) – Specifying the script body from the argument.

Name: Script body

Code: ivrScriptJson

Visibility condition: yes

Default: — 

An argument containing a JSON structure with the body of the IVR script (a JSON array packed into a string).

The structure format is similar to the section `scriptdata.objects`" in the entity IVR script.

Name: Script Code Code: ivrScriptCode Visibility condition: yes

Default: — 

Argument with the IVR script code in the current domain.

Name: Script

Code: ivrScriptCodeSel

Visibility condition: no

Default: — 

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

Name: Script Variables

Code: ivrScriptVars

Visibility condition: yes

Default: — 

An argument containing a JSON structure with script variables (a JSON array packed into a string).

The structure format is similar to the “scriptdata.variables” section in the IVR script entity.

Used when specifying the script body as JSON.

Name: Variable values

Code: ivrScriptVarValuesT

Visibility condition: no

Default: — 

Table of initial values for local variables of the IVR script launched to service the initiated call.

Keys are the names of IVR script variables.

Matching occurs by variable names, values are assigned only to those variables that are defined in the script.

If the launched IVR script transfers control to a nested script, then the assignment of values ​​to each of the specified variables is carried out no more than once, but can be delayed until the nested script that has a variable with the corresponding name is loaded.

Values set this way take precedence over default values within the IVR script.

Name: Parameter 1

Code: param1

Visibility condition: yes

Default: — 

First parameter for the triggered IVR script. The value is accessed through the startparam(1) expression function or by storing the value in the component Start.

Name: Parameter 2

Code: param2

Visibility condition: yes

Default: — 

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

Name: Parameter 3

Code: param3

Visibility condition: yes Default: — 

Third parameter for the triggered IVR script. The value is accessed through the expression function startparam(3).

Name: Parameter 4

Code: param4

Visibility condition: yes

Default: — 

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

Name: Parameter 5 Code: param5 Visibility condition: yes

Default: — 

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

Name: Other parameters

Code: paramsOther

Visibility condition: yes

Default: — 

JSON array containing parameters 6, 7, 8, etc. for a triggered IVR scenario. The value is accessed through the expression function startparam(N), where N > 6.

Name: Time, s

Code: callTimeout

Visibility condition: yes

Default: — 

Time limit for waiting for the subscriber’s final response, in seconds.

Name: SIP response code to variable

Code: sipCode

Visibility condition: yes Default: — 

Variable for storing the last received SIP response code (1xx-6xx).

When waiting for a preliminary SIP response, there will be either a preliminary response (1xx) or a final response (2xx-6xx)

Name: Transition

Code: transfer

Visibility condition: no

Default: — 

The component to which control is transferred if the operation completes successfully.

Name: Transition, failure

Code: transferFail

Visibility condition: no

Default: — 

Component to which control is transferred in case of unsuccessful final SIP response (4xx-6xx).

If not filled in, the transition is carried out along the standard branch.

Name: Transition, no response Code: transferNoAnswer Visibility condition: no

Default: — 

The component to which control is transferred if the waiting time for receiving the final SIP response expires in the final and script completion waiting modes, or the preliminary response in the preliminary response waiting mode.

If not filled in, the transition is carried out along the standard branch.

Name: Transition, error

Code: transferError

Visibility condition: no Default: — 

The component to which control is transferred if any error occurs during the call initiation process.

If not filled in, the transition is carried out along the standard branch.

See also