A call to a subscriber can be made with any parameters, including without subsequent execution of an IVR script. \ After successful completion of the operation, execution of the main script branch is interrupted. \ At any step of the process, a planned failure may occur, then control is transferred to the next component along the appropriate transition branch.

Some subscriber devices and applications make a request to the user and wait for his confirmation when a call is spoofed. This can increase the operating time indefinitely. \ However, after 60 seconds, control will in any case be transferred to the next component along the “Subscription Time” branch.

Two-Step Transfer (Controlled Consultation Call) Component

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

Description

Performs a two-step transfer to a specified number (controlled call transfer). Makes an independent call to a number using a new instance of the IVR script processor, postponing the actual transfer until the moment when the subscriber has already answered and is waiting. After the subscriber answers, the IVR script can be played back to him in advance. The transfer itself is carried out by sending a REFER SIP request with the Replaces attribute to the subscriber. +\

Automatically subscribes to receive events about the state of the translation. The total operating time of the component consists of the time of dialing the specified number, waiting for a response, and the activity of the IVR preplay script. +\

When calling a subscriber by number, the standard routing process is used on behalf of the current IVR script.

If necessary, you should fill the connection waiting interval with a background playback melody (pre-installed playback component). The sendonly media mode with an automatically enabled wait melody is activated only immediately before sending the REFER request, and in the case of the controlled translation component is short-lived and does not provide full playback functionality.

Table 1. System characteristics

Index

217

Short name

refer_attended

Script types

IVR

Start module

r_sip_ivr_script_component_refer_attended

Mode

Asynchronous

Icon

217

Branching type

Branching, interrupting

Properties

Table 2. Properties
Specification Description

Name: Number

Code: number

Visibility condition: no

Default: — 

Argument containing the subscriber’s phone number to carry out the transfer.

Name: Outgoing number

Code: callerId

Visibility condition: no Default: — 

An argument containing CallerId – the username value for substitution in the URI of the From header of the sent SIP INVITE request.

Name: Outgoing name

Code: callerName

Visibility condition: no

Default: — 

An argument containing CallerName – the displayname value for substitution in the URI of the From header of the sent SIP INVITE request.

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.

Headers are inserted into the first (consultation) call (INVITE request). After the subscriber responds, the leverage substitution transfer no longer contains the specified headers in the INVITE with the Replaces header.

Name: Dialing time, s Code: dialingTimeout Visibility condition: no

Default: — 

Lower limit on the subscriber’s call time.

Default call time for internal subscribers is 30 seconds, and can be changed in the SIP user account properties.

Name: IVR script source

Code: setScrMode

Visibility condition: no Default: ``

Method of selecting an IVR script for preliminary playback to the called subscriber.

Possible values:

  • Do not use (none,3) – Do not use the script, just dial, check the answer and switch.

  • From the list (code_sel,2) – Specifying the script code using an argument. Applies the value of the Script property.

  • By code (code,0) – Specifying the script code using an argument. Applies the value of the Script Code property.

  • JSON (body,1) – Specify script code using an argument. Applies the value of the Script Body property.

The pre-playback script must finish with the Stop component before the timeout for the translation to succeed.

Name: Script Code

Code: ivrScriptCode

Visibility condition: yes

Default: — 

Argument with the IVR script code in the current domain.

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: ivrScriptCodeSel Visibility condition: no

Default: — 

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

Name: Variable values

Code: ivrScriptVarValuesT

Visibility condition: yes

Default: — 

Table of initial values for local variables of the IVR script launched for preliminary playback to the called subscriber.

Available only if you are using a pre-playback IVR script to the called party.

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: IVR time, s

Code: ivrTimeout

Visibility condition: no Default: — 

Timeout waiting for IVR script execution.

Name: re-INVITE mode

Code: reinviteMode

Visibility condition: no

Default: Do not use

Selecting the mode of preliminary conversion of the media session of the current dialogue before sending the SIP REFER request.

Possible options:

  • Do not use (not_used, 0) – Does not perform any conversion.

  • Auto (auto, 1) – According to the current system settings, it is similar to the inactive mode.

  • sendonly (2) – Places a media session on hold by sending a re-INVITE from SDP, where media streams have the a=sendonly attribute set.

  • inactive (3) – Puts the media session into hold mode by sending a re-INVITE from SDP, where the a=inactive attribute is set for media streams (does not comply with RFC-6337 clause 5.3.).

Name: Result code into variable Code: resultCode Visibility condition: no

Default: — 

Variable for storing the internal error code.

Possible options:

  • "001" – Error while preparing to initiate a call.

  • "002" – Refusal to initiate a shoulder call.

  • "003" – Timeout when initiating a leverage call.

  • "005" – Preplay script timeout.

  • "008" – Transferred call failed. SIP refusal for INVITE+Replacements.

  • "009" – Call phase timeout.

  • "010" – Crash in the triggered shoulder handler.

Name: Description of the result into a variable

Code: resultDescription

Visibility condition: no

Default: — 

Variable for storing a text description of the internal error.

Name: SIP response code to variable

Code: resultSipCode

Visibility condition: no Default: — 

Variable for storing the SIP response code for an outgoing INVITE request.

Name: Reason for SIP response to variable

Code: resultSipReason

Visibility condition: no

Default: — 

Variable for storing the SIP response phrase for an outgoing INVITE request.

Name: SIP response headers to variable Code: resultSipHeaders Visibility condition: no

Default: — 

Variable for storing a set of SIP response headers to an outgoing INVITE request.

Name: Transition, subscription time

Code: transferSubTerminated

Visibility condition: no

Default: — 

The component to which control is transferred if the subscription time has expired and confirmation of receipt of the final response has not been received.

Name: Transition, failure

Code: transferRejected

Visibility condition: no

Default: — 

The component to which control is transferred if the call receives an unsuccessful final response: 3xx-6xx (to REFER or INVITE).

Name: Transition, time

Code: transferTimeout

Visibility condition: no Default: — 

The component to which control is transferred if a final response to the sent SIP request re-INVITE or REFER is not received within a limited time.

Name: Transition, failure

Code: transferFailed

Visibility condition: no

Default: — 

The component to which control is transferred if the called subscriber does not answer or responds with an unsuccessful final code 3xx-6xx.

Name: Transition, error Code: transferError Visibility condition: no

Default: — 

The component to which control is transferred if the waiting time has expired for the final response to the sent SIP INVITE request, or for the completion of the IVR preplay script.

See also