Overview

Openfax Broadcast Fax Customers can use the Openfax Reporting API to access various reporting data programmatically via SOAP based web services.  This document will help you understand how to securely access these services and which methods are available for Openfax Customers.

Support Inquiries

All questions regarding the Openfax Reporting API should be directed to Tier 2 technical support by opening a support ticket.  Please note that Openfax cannot provide support for application development beyond the scope of the Openfax Reporting API.

Authentication

All Openfax Broadcast Fax accounts are capable of accessing reporting services using the API.  No additional provisioning is required on your account to enable the use of these services.  The only requirement to using the service is to obtain your account's API Key which can be found by logging into our Web Launch Service and clicking the "Retrieve API Key" button from the main menu.  Openfax Support CANNOT provide this key to you.  It can only be obtained via the Web Launch site.  This key is is a unique token that is generated based upon your account number and password.  If you change your account password, you will need to retrieve your API Key again and update your client application with the new key.

Encryption

The Openfax Broadcast Fax Reporting API uses 256-Bit SSL encryption to provide secure communication between the web service consumer client and the Openfax API web servers.  Unencrypted access is not available or permitted.

Service URL

The Openfax Broadcast Fax Reporting API should be accessed at:

https://templaunch.openfax.com/api/reporting.asmx

Web Service Methods

The following web service methods can be called to retrieve data from the Openfax Broadcast Fax Reporting API:

getCDRByJobID

Retrieves a single call detail report for a specific job.  The data is provided as an array of FaxTransmission objects each containing:

TransactionID
A unique identifier to distinguish one record in the CDR from another.

CompletedDate
Date and time the individual transaction was completed.

Phone
The telephony number the fax transmission was attempted to.

Reference
The "To" header that is transmitted which typically is rendered at the top of the fax by the remote fax receiver.

Country
The country or unique rate center that the transaction was attempted to.

ErrorCode
The result of the transaction.  See Openfax Broadcast Fax Error Codes.

Pages
The number of pages transmitted during the transaction.

Duration
The total time in minutes that the transaction took.

For detailed web method syntax, please reference the getCDRByJobID Operation Description.

getRealtime

Retrieves a list of currently running jobs and their progress.  Each job is returned in an array of RealtimeJob objects each containing:

JobID
The unique Openfax Job ID assigned to the job.

BillCode
The user definable field assigned to the job.  It is best practice to populate this field with a unique value when your job is submitted so that you can cross reference this value to determine the JobID of an order.  This will allow you to retrieve the full CDR using getCDRByJobID.

TotalDestinations
The total number of attempted transactions completed at the time of the query.

TotalSuccessful
The total number of successful transactions completed at the time of the query.

TotalFailed
The total number of failed transactions completed at the time of the query. 

For detailed web method syntax, please reference the getRealtime Operation Description.

getRecentHistory 

Retrieves a list of completed jobs run within the last 30 days.  Each job is returned in an array of HistoryJob objects each containing:

JobID
The unique Openfax Job ID assigned to the job.

BillCode
The user definable field assigned to the job.  It is best practice to populate this field with a unique value when your job is submitted so that you can cross reference this value to determine the JobID of an order.  This will allow you to retrieve the full CDR using getCDRByJobID.

TotalDestinations
The total number of attempted transactions for the completed job.

TotalSuccessful
The total number of successful transactions for the completed job.

TotalFailed
The total number of failed transactions for the completed job. 

For detailed web method syntax, please reference the getRecentHistory Operation Description.