Component Fax reception

Table of Contents

Description
Properties
See also

Description

Switches to the image reception mode of T.30 fax protocol or T.30 fax protocol T.38. The component terminates on successful reception or when the set timeout expires.
Places the file in a temporary directory for the lifetime of the script. Saving the file from the script requires that the file is then moved to any stationary storage location.

Table 1. System Characteristics

Index	`214`
Short title	`fax_receive`
Types of scenarios	`IVR`
Starter module	`r_sip_ivr_script_component_fax_receive`
Mode	Asynchronous
Icon
Branching pattern	Branching, closing

Properties

Table 2. Properties
Specification	Description
Title: `Protocol` Code: `proto` Visibility: `no` Default: `T30`	Fax protocol selection. `Auto` (`auto`, `0`) - First an attempt is made to switch to the T38 protocol, and if the remote party fails, a switch to the T30. `T30` (`t30`, `1`) – Switching to T30 and waiting for the remote party to switch to T30. `T38` (`t38`, `2`) – Switching to T38, and if the remote party fails, terminating with an error.
Title: `Timeout, s` Code: `timeoutSec` Visibility: `no` Default: —	Receive timeout before automatic interrupt, in seconds.
Title: `Save Path` Code: `pathToVarMode` Visibility: `no` Default: `Yes'	Switch to save the file path with a write to variable and select the content. Possible options: `Don’t keep` (`dont_save`, `0`) `With folder key` (`script_key_path`, `1`) - The value includes the category, relative path, and filename. `File Name Only` (`only_file_name`, `2`) - The value contains only the file name.
Title: `Path to Variable` Code: `nameVar` Visibility: `yes` Default: —	Variable to store the path to the file with the received fax message. The file is placed in a temporary directory of the script and will be deleted when the script completes. Long-term file retention requires the script to further move the file to a stationary storage location. File format: `tiff` - single page or multi-page bitmap. The message is recorded by the server with the mg role serving the current call and then transferred to the server with the ivr role serving the current scenario. The transfer always takes place within the site.
Title: `Transition` Code: `transfer` Visibility: `no` Default: —	The component to which control is passed when the operation completes typing the desired number of characters.
Title: `Transition, Time` Code: `transferTimeout` Visibility: `no` Default: —	Component to which control is passed on timeout termination.
Title: `Transition, Error` Code: `transferError` Visibility: `no` Default: —	The component to which control is passed if an error occurs.

Component Fax reception

Description

Properties

See also