Viewing Fax Entries

Query Parameters

all_users=true|false

An Admin level user can set this option to query all users instead of just faxes belonging to the authenticated user.

complete_limit=LIMIT

Limit the number of completed faxes returned in a general query (/ffws/v1/ofax) to LIMIT. By default the limit is 10. Faxes displayed in the completed list are (pre)viewable and reschedulable.

class=pending|sending|complete

Retrieve faxes by class.

include_modem_info=true|false

Include modem level information in the response (init_time, connect_time, …). Requesting this information increases the response size. Modem information only exists after the modem has completed at least one full attempt.

HTTP Request Line

GET /ffws/v1/ofax HTTP/1.1

GET /ffws/v1/ofax/FAXKEY HTTP/1.1

GET /ffws/v1/ofax/FAXKEY/ENTRYKEY HTTP/1.1

HTTP Response Status Codes

200 OK

Shows fax entries.

Example

GET /ffws/v1/ofax 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>
	<fax_entry>
	<fax_entry_url>https://192.168.2.1/ffws/v1/ofax/0000001B/0000</fax_entry_url>
	<fax_url>https://192.168.2.1/ffws/v1/ofax/0000001B</fax_url>
	<state>aborted</state>
	<schedule_message>Fax aborted by user</schedule_message>
	<created>2008-08-01 08:43:29</created>
	<stime>2008-08-01 08:52:29</stime>
	<try_number>1</try_number>
	<agent>FFWS</agent>
	<preview>https://192.168.2.1/ffws/v1/data/preview/0000001B-0000.pdf</preview>
	<cover_page>
		<url>https://192.168.2.1/ffws/v1/data/cover_pages/default.pdf</url>
		<enabled>true</enabled>
		<subject>Test Subject</subject>
		<comments>Test Message</comments>
	</cover_page>
	<sender>
		<username>admin</username>
		<name>Sender Name</name>
		<organization>Sender Org</organization>
		<phone_number>218-555-3333</phone_number>
		<fax_number>-218-555-3334</fax_number>
		<email_address>sender@Example.com</email_address>
	</sender>
	<recipient>
		<name>Rcpt 1 Name</name>
		<organization>Rcpt 1 Org</organization>
		<fax_number>218-555-3335</fax_number>
		<phone_number>218-555-3336</phone_number>
	</recipient>
	<max_tries>3</max_tries>
	<priority>3</priority>
	<try_interval>30</try_interval>
	<receipt>failure</receipt>
	<receipt_attachment>none</receipt_attachment>
	<pages>1</pages>
	</fax_entry>
</response>