|
GreenFax Integration Guide (Outbound Faxing)
Application developers who need to send outbound faxes from their application should submit fax jobs to GreenFax using GreenFax's email-to-fax service. GreenFax provides two web service API methods for developers to use for capturing the status of completed outbound fax jobs. HTTP Notify API The HTTP Notify method is used to send status information of completed fax jobs from GreenFax to your system through an HTTP (or HTTPS) GET request. A listener script on your web server is required to receive the information passed in the GET request. Upon completion of a fax job, the GreenFax system will execute an HTTP GET method to the URL of your listener script on your web server, passing status information of the completed job in the query string. The format of the GET request from our system to your listener script will be: http(s)://yourdomain.com/yourscript?result=aaaaa×tamp=bbbbb &destination=ccccc&pages=ddddd&duration=eeeee&userjobcode=fffff &greenfaxreferenceid=ggggg&cost=hhhhh Please note that some of the values in the query string may be URL-encoded. To enable HTTP Notify on your GreenFax account, please email your request to GreenFax Support and include the URL of your listener script. XML Data Feed A log of outbound faxes sent through a GreenFax account is available in XML format over HTTPS. The outbound fax log is accessible via an HTTPS GET request to a URL in the following format: https://www.greenfax.com/api/xml/outbound.php?accountid=aaaaa &password=bbbbb&startdate=cccc-cc-cc&enddate=dddd-dd-dd where:
The XML output of the query will include the following attributes for each fax: GreenFax job id, fax number, sender, status, pages, duration, cost, fax timestamp. |
|
|||||||||||||
