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://172.16.0.13/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://172.16.0.13/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 faxfinders time zone, when the fax --> <!-- was created. --> <!-- This value will be approximately the time when --> <!-- the fax was scheduled. --> <!-- value: string --> <created>2009-01-30T04:43:26</created> <!-- A contextual field which varies based on the --> <!-- state. --> <!-- When the fax is pending this field represents --> <!-- the time when FaxFinder will try to send it. --> <!-- When the fax is sending this field represents --> <!-- the time when FaxFinder actually started sending it. --> <!-- In any other case it is the time of completion. --> <!-- value: string --> <stime>2009-01-30T05:04:00</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://172.16.0.13/ffws/v1/data/preview/00000FD1-0000.pdf</preview> <cover_page> <enabled>false</enabled> <url></url> <subject></subject> <comments></comments> </cover_page> <sender> <username>admin</username> <name></name> <organization></organization> <phone_number></phone_number> <fax_number></fax_number> <email_address></email_address> </sender> <recipient> <name>test recipient</name> <organization>test org</organization> <fax_number>5816</fax_number> <phone_number></phone_number> </recipient> <max_tries>3</max_tries> <priority>3</priority> <try_interval>300</try_interval> <receipt>failure</receipt> <receipt_attachment>failure</receipt_attachment> <pages>6</pages> <approver>_SYSTEM_</approver> <approval_time>2009-01-30T04:43:28</approval_time> <!-- Modem level information included when include_modem_info=true. --> <!-- A modem entry is added for each attempt and is only available --> <!-- after one full attempt has completed. --> <modem_entry> <modem_number>1</modem_number> <status>pass</status> <remote_id>POTS modem 1</remote_id> <size>403498</size> <pages>6</pages> <resolution>Fine</resolution> <baud_rate>33600</baud_rate> <width>1728</width> <height>Variable</height> <data_compression>mh</data_compression> <error_correction>on</error_correction> <init_time>2009-01-30T05:00:09</init_time> <off_hook_time>2009-01-30T05:00:18</off_hook_time> <connect_time>2009-01-30T05:00:51</connect_time> <elapsed_time>172</elapsed_time> <scan_line_time>0</scan_line_time> </modem_entry> </fax_entry>