Multitech FF240 Server User Manual


 
Appendix B: Customization
Multi-Tech Systems, Inc. FF240-IP Admin User Guide 112
Fax Entry Element
This element represents an actual fax that will be sent. Some of the elements are the same as elements
provided in schedule_fax. See the documentation above for an explanation of those fields.
<!-- Describes a Fax Entry -->
<fax_entry>
<!-- URL of this fax_entry -->
<!-- value: string -->
<fax_entry_url>https://192.168.2.1/ffws/v1/ofax/00000FD1/0000</fax_entry_url>
<!-- URL of scheduled_fax group to which this fax_entry is a part of -->
<!-- value: string -->
<fax_url>https://192.168.2.1/ffws/v1/ofax/00000FD1</fax_url>
<!-- Current state of this fax entry -->
<!-- Can be one of: -->
<!-- preprocessing-->
<!-- approval_pending -->
<!-- pending -->
<!-- sending -->
<!-- sent -->
<!-- aborted -->
<!-- failed -->
<!-- dead -->
<!-- value: string -->
<state>sent</state>
<!-- Human readable string describing the current status -->
<!-- value: string -->
<schedule_message>Successfully sent fax</schedule_message>
<!-- Human readable time representing the time -->
<!-- in the FF240-IPs time zone, when the fax -->
<!-- was created. -->
<!-- This value will be approximately the time when -->
<!-- the fax was scheduled. -->
<!-- value: string -->
<created>2008-08-01 08:43:29</created>
<!-- A contextual field which varies based on the -->
<!-- state. -->
<!-- When the fax is pending this field represents -->
<!-- the time when FF240-IP will try to send it. -->
<!-- When the fax is sending this field represents -->
<!-- the time when FF240-IP actually started sending it. -->
<!-- In any other case it is the time of completion. -->
<!-- value: string -->
<stime>2008-08-01 08:52:29</stime>
<!-- The number of unsuccessful tries that have already occurred -->
<!-- value: string -->
<try_number>1</try_number>
<!-- Sending Agent -->
<!-- value: string -->
<agent>FFWS</agent>
<!-- Fax Preview URL -->
<!-- value: string -->
<preview>https://192.168.2.1/ffws/v1/data/preview/00000FD1-0000.pdf</preview>