Appendix B: Customization
Multi-Tech Systems, Inc. FaxFinder Admin User Guide 95
<subject>Test Subject</subject>
<comments>Test Message</comments>
</cover_page>
<sender>
<username>admin</username>
<name>Sender Name</name>
<organization>Sender Org</organization>
<phone_number>111-222-3333</phone_number>
<fax_number>111-222-3334</fax_number>
<email_address>sender@example.com</email_address>
</sender>
<recipient>
<name>Rcpt 1 Name</name>
<organization>Rcpt 1 Org</organization>
<fax_number>111-222-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>
Retrieving Fax Entries
Fax Entries are retrieved by sending a GET request to /ffws/v1/ofax. If the query is successful then a
response element is returned which contains all fax_entry elements matching the query. In the case of a
simple GET without a query string, all fax entries for the user are returned.
Sending a GET request to the URL found in the fax_url element will return all fax entries associated with
that particular scheduled fax.
Sending a GET request to the URL found in the fax_entry_url element will return the fax entry associated
with the URL.
Optional 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 re-schedulable.
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 is costly and it also
increases the size of the response. Modem information only exists after the
modem has completed at least one full attempt.
To Next Page
Loading...
