Custom routing for outgoing faxes (Microsoft Fax)

Parent Previous Next

The Custom Routing Method (Microsoft Fax) allows you to easy add any routing functionality by using custom application that is started after sending a fax. The using of this method is not limited by the current licences.


This method provides software vendors with a flexible way to connect software applications that route outgoing fax through multiple routing methods. These routing methods can include, but are not limited to: printing faxes, storing faxes, converting fax graphic images to text files, delivering faxes in electronic mail attachments etc. The software vendor is responsible for developing functions of the method, for creating graphical user interface (GUI) to configure the rules and other settings, and for storing the configuration.


When executing Custom Routing Method (Microsoft Fax), Fax Voip starts the application, specified by the customer, after sending a fax. The command line passed to an application is predefined and contains all the necessary information. The developer of the custom application can parse the command line in his application to obtain the path to the fax file and other important parameters, such as Recipient Fax Number, TSID, CSID etc. and then do any necessary actions. The custom application must be terminated automatically after execution. The application is responsible for deleting the temporary copy of the outgoing fax (TIFF, PDF or SFF file) and the folder in which this file is placed. Custom Application is started using the current user account or user account under which the Mail to Fax service (MS Fax) is running (if Fax Voip is running as a Windows service), so the corresponding account must have necessary access to files, folders and other objects with which your application works. See more details in the Custom Application Requirements (Developer's Guide) chapter of this user manual.



Custom application that should be started after sending a fax

Here you can choose the application that will be started after sending a fax. You can browse to a preferred executable file or enter the file path. The example of the custom routing application (RouteOutCustomMS.exe) can be found in the Fax Voip installation folder, usually C:\Program Files (x86)\FaxVoip\RouteOutCustomMS.exe. See also in the Custom Application Sample chapter of this user manual.

Create temporary copy of the sent fax in the following format:

If you select this option, the method creates a temporary folder (subfolder in the %temp% folder for the current user account or user account under which the Mail to Fax service (MS Fax) is running) and copies the outgouing fax (TIFF, PDF or SFF file depending on your choice) into this folder. The path to the temporary folder (%temp%) is usually C:\Users\<Account Name>\AppData\Local\Temp\. The path to the temporary fax file is passed to the custom application via FaxFileName command-line argument. The custom application is responsible for deleting the temporary fax file and the temporary folder in which this file is located. If this option is not checked, the method does not create the copy of the outgouing fax, but the custom application can still access the outgouing fax by using Fax Service API functions (based on Job ID parameter that is also passed via command line).

Enable custom routing

If you select this option, the Fax Voip software applies the Custom Routing Method (Microsoft Fax) for all outgouing faxes sent using Microsoft Fax application (via Fax Voip Virtual COM Ports).