|
GreenFax Integration Guide (Inbound Faxing)
GreenFax provides two web service API methods for developers to use for accessing inbound faxes received. HTTPS Notify API The HTTPS Notify method can be used to notify your application when an inbound fax is received on one of your inbound fax lines, through an HTTPS GET request. A listener script on your web server is required to receive the information passed in the GET request. Upon receipt of a fax on one of your GreenFax lines, the GreenFax system will execute an HTTP GET method to the URL of your listener script on your web server, passing information about the incoming fax in the query string. The format of the GET request from our system to yours will be: https://yourdomain.com/yourscript?greenfax_job_id=aaaaa &inbound_fax_number=bbbbb&fax_timestamp=ccccc&pages=ddddd &sender=eeeee&filename=fffff&download_url=ggggg Your application can then download the fax document directly from the download_url provided. Please note that some of the values in the query string may be URL-encoded. To enable HTTPS Notify on one or more of your fax lines, please email your request to GreenFax Support and include the URL of your listener script, and the inbound fax line(s) to apply it to. XML Datafeed A log of the inbound faxes received on a particular inbound fax number is available in XML format over HTTPS. The inbound fax log is accessible via an HTTPS GET request to a URL in the following format: https://www.greenfax.com/api/xml/inbound.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, timestamp, pages, sender, filename, and a URL from which the fax document can be downloaded. Your application can download the fax document directly from the document download URL provided. |
|
|||||||||||||
