Component transfer with controlled call

Table of Contents

Description
Properties
See also

Description

Performs a controlled transfer to a number. Performs an independent call to a number via a new instance of the IVR script handler, delaying the direct transfer until the caller has already answered and is waiting. After the subscriber answers, the IVR script can be preplayed to him/her. Direct transfer is performed by sending a REFER SIP-request to the subscriber with the attribute Replaces.
A call to a subscriber can be made with any parameters, including without subsequent IVR script execution. After successful completion of the operation, the execution of the main branch of the script is aborted. At any step in the process, a planned failure may occur, then control is transferred to the next component along the appropriate transition branch.

Automatically subscribes to receive transfer status events. The total component operation time is made up of the time of dialing the specified number, waiting for the answer, IVR script preplay activity.
Some subscriber devices and applications make a request to the user and wait for confirmation when the call is spoofed. This can increase the operation time indefinitely. However, after 60 seconds, control will in any case be transferred to the next component on the "Subscription time" branch".

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

If necessary, fill the connection waiting interval with a background melody (pre-set playback component). The sendonly media mode with an automatically connected ringtone is only activated just before sending a REFER request, and in the case of the supervised transfer component is short-lived and does not provide full playback functionality.

Table 1. System Characteristics

Index	`217`
Short title	`refer_attended`
Types of scenarios	`IVR`
Starter module	`r_sip_ivr_script_component_refer_attended`
Mode	Asynchronous
Icon
Branching pattern	Branching, interrupting

Properties

Table 2. Properties
Specification	Description
Title: `Number` Code: `number` Visibility: `no` Default: —	Argument containing the phone number of the subscriber to transfer to.
Title: `Outgoing Number` Code: `callerId` Visibility: `no` Default: —	Argument containing CallerId - username value to substitute in the URI of the `From` header of the SIP request to be sent INVITE.
Title: `The Descending Name Code: `callerName` Visibility: `no` Default: —	The argument containing CallerName is the displayname value to substitute into the URI of the `From` header of the SIP request to be sent INVITE.
Title: `Dialing time, s` Code: `dialingTimeout` Visibility: `no` Default: —	Lower limit on the caller’s calling time. The default internal call time is 30 seconds and can be changed in the SIP user account properties.
Title: `Script Source IVR` Code: `setScrMode` Visibility: `no` Default: ``	Method for selecting the IVR script to be preplayed to the called party. Possible values: `Do not use` (`none`,`3`) - Do not use the script, only make the call, monitor the response and switch. `From list` (`code_sel`,`2`) - Specifies the script code with an argument. Applies the value of the `Scenario property`. `By code` (`code`,`0`) - Specifies the script code using an argument. Applies the value of the `Scenario Code` property`. `JSON` (`body`,`1`) – Specifies the script code with an argument. Applies the value of the `Scenario Body property`. The pre-replay script must have time to timeout before the Stop component terminates in order for the transfer to succeed.
Title: `Scenario Code` Code: `ivrScriptCode` Visibility: `yes` Default: —	Argument with the IVR script code in the current domain.
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: `ivrScriptCodeSel` Visibility: `no` Default: —	Drop-down list with script codes. Contains all available (non-hidden) IVR scripts contained in the current domain.
Title: `Variable Values` Code: `ivrScriptVarValuesT` Visibility: `yes` Default: —	Table of initial values for the local variables of the IVR script run for pre-playback to the caller. Available only if the IVR preplay script to the called party is used. 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 IVR, c` Code: `ivrTimeout` Visibility: `no` Default: —	Waiting timeout for IVR script execution.
Title: `Mode re-INVITE` Code: `reinviteMode` Visibility: `no` Default: Default: `Do not use	Selects the media session preconversion mode of the current dialog before sending a SIP request REFER. Possible options: `Not Used` (`not_used`, `0`) - Does not perform conversions. Auto (`auto, `1`) - At current system settings similar to the mode `inactive`. `sendonly` (`2`) – Places a media session on hold by sending a re-INVITE from an SDP where media streams have the attribute set to `a=sendonly`. `inactive` (`3`) – Places a media session on hold by sending a re-INVITE from an SDP where media streams have the `a=inactive` attribute set (not compliant with RFC-6337 clause.5.3.).
Title: `Result code to variable` Code: `resultCode` Visibility: `no` Default: —	Variable to store the internal error code. Possible options: `"001"` – Call initiation error. `"002"` – Failure to challenge.
Title: `Describing the result to a variable` Code: `resultDescription` Visibility: `no` Default: —	Variable to store the text description of the internal error.
Title: `SIP response code to variable` Code: `resultSipCode` Visibility: `no` Default: —	Variable to store the SIP response code for an outgoing request INVITE.
Title: `Reason for SIP response to variable` Code: `resultSipReason` Visibility: `no` Default: —	Variable to store the SIP response phrase to an outgoing request INVITE.
Title: `SIP response headers to variable` Code: `resultSipHeaders` Visibility: `no` Default: —	Variable to store a set of SIP response headers for an outgoing request INVITE.
Title: `Transition, subscription time` Code: `transferSubTerminated` Visibility: `no` Default: —	The component to which control is passed if the subscription time has expired and there is no acknowledgement of receipt of the final response.
Title: `Transition, Abandonment` Code: `transferRejected` Visibility: `no` Default: —	Component to which control is passed in case the call receives an unsuccessful final response: `3xx-6xx` (on REFER or INVITE).
Title: `Transition, Time` Code: `transferTimeout` Visibility: `no` Default: —	The component to which control is transferred in case no final response to a sent SIP request is received within a limited time re-INVITE or REFER.
Title: `Transition, Failure` Code: `transferFailed` Visibility: `no` Default: —	The component to which control is transferred in case the called party does not answer, or answers with an unsuccessful final code 3xx-6xx.
Title: `Transition, Error` Code: `transferError` Visibility: `no` Default: —	The component to which control is transferred when the time to wait for a final response to a sent SIP INVITE request has elapsed, or when the IVR preplay script has completed.

Component transfer with controlled call

Description

Properties

See also