Viewing Outbound Fax Status

Requires FaxFinder 3.0.4 or higher.

Query Parameters class=pending|sending (Default=pending and sending)

Limit outbound status listing to a set number of pending and sending faxes.p>

pending_limit=PEND_LIMIT (Default=10)

Use with class. Limits pending faxes to specified number. If pending_limit is not specified, class returns ten pending faxes. p>

sending_limit=SEND_LIMIT (Default=10)

Use with class. Limits sending faxes to specified number. If sending_limit is not specified, class returns ten sending faxes.
HTTP Request Line GET /ffws/v1/outbound_status HTTP/1.1
HTTP Response Status Codes 200 OK Shows status for currently outbound faxes.
404 Not Found No current outbound faxes found.

Example

GET /ffws/v1/outbound_status 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://dot10/ffws/v1/ofax/00000109/0001</fax_entry_url>
			<fax_url>https://dot10/ffws/v1/ofax/00000109</fax_url>
			<state>sending</state>
			<schedule_message></schedule_message>
			<created>2013-07-16T21:25:17</created>
			<stime>2013-07-16T21:25:30</stime>
			<try_number>1</try_number>
			<agent>WebClient</agent>
<!--To view the fax -->
			<preview>https://dot10/ffws/v1/data/preview/00000109-0001.pdf</preview>   
			<cover_page>
				  <enabled>true</enabled>
				  <url>https://dot10/ffws/v1/data/cover_pages/mts_template3.pdf</url>
				  <subject>test</subject>
				  <comments>test faxes for outbound and inbound status</comments>
			</cover_page>
			<sender>
				  <username>admin</username>
				  <name>Administrator</name>
				  <organization></organization>
				  <phone_number>1234</phone_number>
				  <fax_number></fax_number>
				  <email_address>cla@mts.test</email_address>
			</sender>
			<recipient>
				  <name>Avaya and Back 2</name>
				  <organization></organization>
				  <fax_number>8102</fax_number>
				  <phone_number></phone_number>
			</recipient>
			<max_tries>1</max_tries>
			<priority>3</priority>
			<try_interval>300</try_interval>
			<receipt>failure</receipt>
			<receipt_attachment>pdf</receipt_attachment>
			<pages>2</pages>
			<approver>_SYSTEM_</approver>
			<approval_time>2013-07-16T21:25:24</approval_time>
	  </fax_entry>
</response>