GreenFax Integration Guide
Application developers that need to send outbound faxes from their application should submit fax jobs to GreenFax through GreenFax's email-to-fax gateway.
GreenFax provides two web service API's for integrators and application programmers to use for capturing the status of outbound fax jobs submitted to GreenFax.
HTTP Notify API
The HTTP Notify method is used to send status information of a completed fax job from GreenFax to your system through HTTP protocol. Upon completion of a fax job, the GreenFax system will execute an HTTP GET method
to a URL of a target script on your web server, passing status information of the completed job in a URL-encoded query string. The format of the data passed in the URL query string (without URL encoding) is shown in the example below:
To enable HTTP Notify on your GreenFax account, please email your request to GreenFax Support and include the URL of your target script.
XML Data Feed
The GreenFax XML data feed can be used to provide integrators and application developers with real-time data
for accessing the status and history of fax jobs submitted to the GreenFax system within a specified date range.
The data feed is accessed through http or https protocol, however GreenFax recommends using https protocol for security reasons because account authentication information must be passed. The URL is:
where:
| greenfax_account_id: | 5-digit GreenFax account id |
| greenfax_account_login_password: | GreenFax account login password |
| date_range_start: Format: | YYYY-MM-DD or YYYY-MM-DD%hh:mm:ss |
| date_range_end: Format: | YYYY-MM-DD or YYYY-MM-DD%hh:mm:ss |
The GreenFax system will produce the requested data in XML format. The XML schema used self-expanatory (see sample).
Date range may not exceed 90 days. Please limit your XML requests to no more than one request every 20 minutes.
|
|
