Viewing Outbound 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/outbound_log HTTP/1.1

GET /ffws/v1/outbound_log/FAXKEY HTTP/1.1

GET /ffws/v1/outbound_log/FAXKEY/ENTRYKEY HTTP/1.1
HTTP Response Status Codes 200 OK Shows outbound fax log.
400 Bad Request The provided XML is not valid.

Example

GET /ffws/v1/outbound_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>
	<outbound_fax_entry>
		<fax_entry_url>https://dot10/ffws/v1/outbound_log/00000110/0000</fax_entry_url>
		<fax_url>https://dot10/ffws/v1/outbound_log/00000110</fax_url>
<!--To view the fax -->
		<preview>https://dot10/ffws/v1/data/preview/00000110-0000.pdf</preview>   
		<status>sent</status>
		<start_time>07/23/2013 04:02:16 PM</start_time>
		<end_time>07/23/2013 04:03:05 PM</end_time>
		<username>admin</username>
		<agent>WebClient</agent>
		<pages>0</pages>
		<cover_page_used>1</cover_page_used>
		<cover_page_name>mts_template3.pdf</cover_page_name>
		<priority>3</priority>
		<sender_name>Administrator</sender_name>
		<sender_email>cla@mts.test</sender_email>
		<sender_phone>1234</sender_phone>
		<sender_fax></sender_fax>
		<sender_organization></sender_organization>
		<recipient_name>Avaya and Back 1</recipient_name>
		<recipient_fax>8101</recipient_fax>
		<recipient_phone></recipient_phone>
		<recipient_organization></recipient_organization>
		<subject></subject>
		<comments>test</comments>
		<call_entry>
			<modem_number>4</modem_number>
			<status>pass</status>
			<remote_id>FF240-IP</remote_id>
			<size>60342</size>
			<pages>1</pages>
			<resolution>Fine</resolution>
			<baud_rate>14400</baud_rate>
			<width></width>
			<height></height>
			<data_compression>MMR</data_compression>
			<error_correction>enabled</error_correction>
			<init_time></init_time>
			<off_hook_time></off_hook_time>
			<connect_time>2013-07-23T21:02:37</connect_time>
			<elapsed_time>25</elapsed_time>
			<scan_line_time>0</scan_line_time>
			<modulation>V17</modulation>
		</call_entry>
	</outbound_fax_entry>
</response>