Connector API

The Connector API for NET SatisFAXtion offers developers a simple means of sending faxes, by creating structured text files, or "ASCII packets", that contain all of the sending parameters for a fax or fax broadcast.  Originally developed as an interface to NET SatisFAXtion for FaxBack fax-on-demand products, this API is ideal for sending faxes from applications written in any language, and even those running on a mainframe or non-PC system.


To use the Connector API, the option "Load Connector API module"  must be enabled on the "API Settings" page of the NET SatisFAXtion configuration program.  To make this change, run "Change Server Settings" from the NET SatisFAXtion start-menu.  Once this option is enabled, and the server has been loaded, the Connector API will be operational.




Overview

With the Connector API enabled, the fax server periodically scans an order directory looking for new packets (i.e., files).  The default order directory is C:\FaxBack\FaxServr\Orders.  The fax server looks for files with extensions that begin with "T" or "S", for example, "NEWFAX.T02".  The "S" extension stands for "single call", and is specialized for fax-on-demand applications, where a fax will be delivered on the same phone call that has been used to order documents using voice prompts.  The "T" extension stands for "two call", which is named from the perspective of a fax-on-demand application where the fax will be delivered later, on a separate call.  However, "T" packets can be submitted anytime by any application, to send faxes to one more more recipients.

The contents of a "T" order packet must include a fax number and fax contents (cover page, attachments, or both).  Orders can also be scheduled for delivery at a later date and time.  The format of a packet is similar to an .INI file, consisting of sections with each parameter being on a line by itself, for example:

[OrderPacket]
From=FaxBack, Inc.
FaxNumber=503-614-5399
To=Joe Smith
Subject=Just a test
File1=p:\personal\mikel\b.tif
[Message]
This text appears on the cover page.  Put this section at the end of the file.  You can include more than one line.

After an order has been processed, it will either be deleted, or if a "completion directory" has been defined, it will be moved into the completion directory and renamed with an extension that begins with "P".  Completed order packets include a [Logging] section that contains information about the delivery of the fax message, for example:

[Logging]
FaxStatusNum=0
FaxStatus=Ok
PortUsed=Fax13
ScheduledTime=05/21/2000 15:29:08
SubmitTime=05/21/2000 15:29:08
StartTime=05/21/2000 15:29:08
ReceiverCSID=503 614 5399
ConnectionTime=135
NumberOfErrors=0
Retries=0
SenderCSID=

Completed orders ("P" packets) are opened by an application and the results are read from the [Logging] section, after which the "P" packet is deleted.

Summary

The Connector API is one of the easiest ways to send faxes with NET SatisFAXtion.  All your application needs is the ability to create an ASCII file in the order directory.

For detailed information about the the Connector API, download Connector API V9-2.doc.