Component Transfer to number

Table of Contents

Description
Properties
See also

Description

Transfers the subscriber of the current call to the specified number by sending a SIP-request to it REFER.
After successful execution of the component, 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 time of the transfer process is made up of the time to respond to the REFER (may include issuing a request to the subscriber with waiting for confirmation), dialing the specified number, and waiting for a response. However, after 60 seconds, control will in any case be transferred to the next component on the "Subscription time" branch".

The transfer uses the standard routing process on behalf of the current script IVR.

Table 1. System Characteristics

Index	`203`
Short title	`refer`
Types of scenarios	`IVR`
Starter module	`r_sip_ivr_script_component_refer`
Mode	Asynchronous
Icon
Branching pattern	Branching, interrupting

Properties

Table 2. Properties
Specification	Description
Title: `Number` Code: `number` Visibility: `no` Default: —	Argument containing the telephone number of the subscriber to make the transfer.
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: `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.

Component Transfer to number

Description

Properties

See also