Receive outgoing fax confirmations via callback to a web application

You can select to receive fax status notifications directly to your system by using the Outgoing Web Feedback function. When this feature is set, InterFAX sends fax confirmations to a web application that you set up. Your web application should be capable of accepting either an HTTP POST call or a XML Web Service (SOAP) call.

You can also set the system to send you notifications on new inbound faxes. For more information, please read the inbound callback documentation.

Preparatory steps

HTTP POST callback

To receive HTTP POST callbacks to a simple script on your server, no preparation is necessary. Skip to "Setting up the callback" below.

SOAP callback

To receive callbacks to a SOAP server, perform these setup steps:

  1. Set up a web application that is capable of accepting callbacks on your server. If you set up a SOAP server, its namespace should be http://CallBack.Interfax.net/ (namespace is case sensitive, this is the expected WSDL).
  2. The web method name should be "Outbound".
  3. The web method should return a string -> "OK".

Setting up the callback

Login to your InterFAX account and go to Preferences -> Outgoing -> Feedback. Find and set the following settings under Advanced Options -> Web Feedback:
 

Selection Description Possible Values
Web Feedback When Under which condition should feedback be sent Never (disables Web Feedback), On Success, On Failure, Always
Web Feedback Method What type of callback does your web application expect XML Web Service, HTTP POST
Web Feedback URL The URL to your web application. Any valid web address

 

Callback contents

Once Web Feedback is set up, the InterFAX system will call back your web app and provide the following values:
 

Parameter Name Parameter Type Description
TransactionIDType String Fixed string: Outbound
TransactionID Long The ID of this transaction
CompletionTime DateTime The time and date that the fax was completed, in time zone GMT
When returned via HTTP POST: dd/mm/yyyy hh:mm:ss
When returned via Web Service: ISO-8601 compliant
Contact String The name of the contact – if applicable
CostPerUnit Decimal The cost for each unit. Multiply this by 'Units' (below) to get the cost of the fax.
DeleteAfterUsage String Whether the fax image is to be deleted after the fax has been completed or not (for enhanced security)
DestinationFax String The number that the fax was sent to
Duration Integer The time (in seconds) that it took to send the fax
JobID String Reserved for future use
MessageID String Reserved for future use
Mode String Reserved for future use
NumOfTransactions Integer The number of transactions in the parent transaction
PageHeader String Shows the page header (if applicable)
PageOrientation String The orientation that the page was set to – portrait or landscape
PageResolution String The resolution that the page was set to – standard or high
PageSize String The page size that was sent
PagesSent Integer The number of pages that were sent
PagesSubmitted Integer The number of pages that were received in the InterFAX system
ParentTransactionID Long If the fax was part of a list, then this field will show the transaction ID of the list
PostponeTime DateTime The date and time that the fax was postponed to, in time zone GMT. Returns zeros if no value set.
When returned via HTTP POST: dd/mm/yyyy hh:mm:ss
When returned via Web Service: ISO-8601 compliant
Priority Integer The priority this fax received
RemoteCSID String The CSID of the recipient
RenderingQuality String The quality of the rendering – high or low
ReplyEmail String The e-mail address that the email feedback will be sent to
RetriesInterval Integer The interval to wait between each attempt
RetriesToPerform Integer The number of retries to do
SenderCSID String The CSID of the sender
Status Integer Status of the fax. See the list of InterFAX Error Codes
Subject String The subject of the fax
SubmitTime DateTime The date and time when the fax was received in the InterFAX system
When returned via HTTP POST: dd/mm/yyyy hh:mm:ss
When returned via Web Service: ISO-8601 compliant
TrialsPerformed Integer The number of attempts made
Units Decimal Duration units required to send the fax. Multiply this by 'CostPerUnit' (above) to get the cost of the fax.
UserData String Reserved for future use
UserID String The user name that sent the fax