Viewing Inbound Fax Logs

Requires FaxFinder 3.0.4 or higher.

Query Parameters

limit=LIMIT

Limit the number of results to LIMIT.

index=INDEX (Must be used with limit)

Index indicates where to start reading the data in the database. Use to page through data.

include_call_info=true|false

Set to true to include call details. Requesting this information increases the response size.

HTTP Request Line

GET /ffws/v1/inbound_log HTTP/1.1

GET /ffws/v1/inbound_log/FAXKEY HTTP/1.1

HTTP Response Status Codes

200 OK

Shows inbound fax log.

400 Bad Request

The provided XML is not valid.

Example

GET /ffws/v1/inbound_log HTTP/1.1 
content-type: application/xml 
authorization: Basic YWRtaW46YWRtaW4= 
----------------------------------- 
HTTP/1.1 200 OK 
content-type: application/xml
<?xml version=”1.0” encoding=”UTF-8”?> 
<response>
	  <message>Success</message>
	  <inbound_fax_entry>
			<filename>fax_inbound_20131023_135211_recv0000.tif</filename>
			<status>complete</status>
			<complete_time>07/24/2013 09:50:18 PM</complete_time>
			<remote_id>POTS modem - 5739</remote_id>
			<pages>1</pages>
			<extension></extension>
			<recipient_name>Line 2</recipient_name>
			<channel>2<channel> OR <modem>2</modem>
			<delivered_to>
				  <type>Email</type>
				  <destination>cla@mts.test</destination>
			</delivered_to>
			<delivered_to>
				  <type>Email</type>
				  <destination>sdfa@sdf.com</destination>
			</delivered_to>
			<delivery_error>  (Only if there were errors)
				<error></error>
			</delivery_error>
			<call_entry>
				<modem_number>2</modem_number>
				<status>pass</status>
				<remote_id>POTS modem - 5739</remote_id>
				<size>24298</size>
				<pages>1</pages>
				<resolution>Fine</resolution>
				<baud_rate>14400</baud_rate>
				<width>1728</width>
				<height>Variable</height>
				<data_compression>mh</data_compression>
				<error_correction>on</error_correction>
				<init_time>2013-07-24T17:25:49</init_time>
				<off_hook_time>2013-07-24T18:49:36</off_hook_time>
				<connect_time>2013-07-24T18:49:49</connect_time>
				<elapsed_time>25</elapsed_time>
				<scan_line_time>0</scan_line_time>
			</call_entry>
			<location>//172.16.0.5/share/archive/inbound/user1/fax_inbound_20131023_135211_recv0000.tif</location>
	  </inbound_fax_entry>
</response>