
Appendix B: Customization
Multi-Tech Systems, Inc. FaxFinder Admin User Guide 109
<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>111-222-3333</phone_number>
<fax_number>111-222-3334</fax_number>
</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>0</pages>
<approver></approver>
<approval_time></approval_time>
</fax_entry>
</response>
Retrieving Fax Entries
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
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.
Commenti su questo manuale