{"id":5250,"date":"2025-02-05T13:25:22","date_gmt":"2025-02-05T19:25:22","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=5250"},"modified":"2025-02-05T13:27:42","modified_gmt":"2025-02-05T19:27:42","slug":"fax-entry-element","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/faxfinder-information-apis-and-elements\/fax-entry-element\/","title":{"rendered":"Fax Entry Element"},"content":{"rendered":"<p>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.<\/p>\n<pre class=\"brush:xml\">\r\n&lt;!-- Describes a Fax Entry --&gt;\r\n&lt;fax_entry&gt; \r\n&lt;!-- URL of this fax_entry --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;fax_entry_url&gt;https:\/\/172.16.0.13\/ffws\/v1\/ofax\/00000FD1\/0000&lt;\/fax_entry_url&gt; \r\n&lt;!-- URL of scheduled_fax group to which this fax_entry is a part of --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;fax_url&gt;https:\/\/172.16.0.13\/ffws\/v1\/ofax\/00000FD1&lt;\/fax_url&gt; \r\n&lt;!-- Current state of this fax entry --&gt;\r\n&lt;!-- Can be one of: --&gt;\r\n&lt;!-- preprocessing--&gt;\r\n&lt;!-- approval_pending --&gt;\r\n&lt;!-- pending --&gt;\r\n&lt;!-- sending --&gt;\r\n&lt;!-- sent --&gt;\r\n&lt;!-- aborted --&gt;\r\n&lt;!-- failed --&gt;\r\n&lt;!-- dead --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;state&gt;sent&lt;\/state&gt; \r\n&lt;!-- Human readable string describing the current status --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;schedule_message&gt;Successfully sent fax&lt;\/schedule_message&gt; \r\n&lt;!-- Human readable time representing the time --&gt;\r\n&lt;!-- in the faxfinders time zone, when the fax --&gt;\r\n&lt;!-- was created. --&gt;\r\n&lt;!-- This value will be approximately the time when --&gt;\r\n&lt;!-- the fax was scheduled. --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;created&gt;2009-01-30T04:43:26&lt;\/created&gt; \r\n&lt;!-- A contextual field which varies based on the --&gt;\r\n&lt;!-- state. --&gt;\r\n&lt;!-- When the fax is pending this field represents --&gt;\r\n&lt;!-- the time when FaxFinder will try to send it. --&gt;\r\n&lt;!-- When the fax is sending this field represents --&gt;\r\n&lt;!-- the time when FaxFinder actually started sending it. --&gt;\r\n&lt;!-- In any other case it is the time of completion. --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;stime&gt;2009-01-30T05:04:00&lt;\/stime&gt; \r\n&lt;!-- The number of unsuccessful tries that have already occurred --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;try_number&gt;1&lt;\/try_number&gt; \r\n&lt;!-- Sending Agent --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;agent&gt;FFWS&lt;\/agent&gt; \r\n&lt;!-- Fax Preview URL --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;preview&gt;https:\/\/172.16.0.13\/ffws\/v1\/data\/preview\/00000FD1-0000.pdf&lt;\/preview&gt; \r\n\t&lt;cover_page&gt; \r\n\t\t&lt;enabled&gt;false&lt;\/enabled&gt; \r\n\t\t&lt;url&gt;&lt;\/url&gt; \r\n\t\t&lt;subject&gt;&lt;\/subject&gt; \r\n\t\t&lt;comments&gt;&lt;\/comments&gt; \r\n\t&lt;\/cover_page&gt; \r\n\t&lt;sender&gt; \r\n\t\t&lt;username&gt;admin&lt;\/username&gt; \r\n\t\t&lt;name&gt;&lt;\/name&gt; \r\n\t\t&lt;organization&gt;&lt;\/organization&gt; \r\n\t\t&lt;phone_number&gt;&lt;\/phone_number&gt; \r\n\t\t&lt;fax_number&gt;&lt;\/fax_number&gt; \r\n\t\t&lt;email_address&gt;&lt;\/email_address&gt; \r\n\t&lt;\/sender&gt; \r\n\t&lt;recipient&gt; \r\n\t\t&lt;name&gt;test recipient&lt;\/name&gt; \r\n\t\t&lt;organization&gt;test org&lt;\/organization&gt; \r\n\t\t&lt;fax_number&gt;5816&lt;\/fax_number&gt; \r\n\t\t&lt;phone_number&gt;&lt;\/phone_number&gt; \r\n\t&lt;\/recipient&gt; \r\n\t&lt;max_tries&gt;3&lt;\/max_tries&gt; \r\n\t&lt;priority&gt;3&lt;\/priority&gt; \r\n\t&lt;try_interval&gt;300&lt;\/try_interval&gt; \r\n\t&lt;receipt&gt;failure&lt;\/receipt&gt; \r\n\t&lt;receipt_attachment&gt;failure&lt;\/receipt_attachment&gt; \r\n\t&lt;pages&gt;6&lt;\/pages&gt; \r\n\t&lt;approver&gt;_SYSTEM_&lt;\/approver&gt; \r\n\t&lt;approval_time&gt;2009-01-30T04:43:28&lt;\/approval_time&gt; \r\n&lt;!-- Modem level information included when include_modem_info=true. --&gt;\r\n&lt;!-- A modem entry is added for each attempt and is only available --&gt;\r\n&lt;!-- after one full attempt has completed. --&gt;\r\n\t&lt;modem_entry&gt; \r\n\t\t&lt;modem_number&gt;1&lt;\/modem_number&gt; \r\n\t\t&lt;status&gt;pass&lt;\/status&gt; \r\n\t\t&lt;remote_id&gt;POTS modem 1&lt;\/remote_id&gt; \r\n\t\t&lt;size&gt;403498&lt;\/size&gt; \r\n\t\t&lt;pages&gt;6&lt;\/pages&gt; \r\n\t\t&lt;resolution&gt;Fine&lt;\/resolution&gt; \r\n\t\t&lt;baud_rate&gt;33600&lt;\/baud_rate&gt; \t\r\n\t\t&lt;width&gt;1728&lt;\/width&gt; \r\n\t\t&lt;height&gt;Variable&lt;\/height&gt; \r\n\t\t&lt;data_compression&gt;mh&lt;\/data_compression&gt; \r\n\t\t&lt;error_correction&gt;on&lt;\/error_correction&gt; \r\n\t\t&lt;init_time&gt;2009-01-30T05:00:09&lt;\/init_time&gt; \r\n\t\t&lt;off_hook_time&gt;2009-01-30T05:00:18&lt;\/off_hook_time&gt; \r\n\t\t&lt;connect_time&gt;2009-01-30T05:00:51&lt;\/connect_time&gt; \r\n\t\t&lt;elapsed_time&gt;172&lt;\/elapsed_time&gt; \r\n\t\t&lt;scan_line_time&gt;0&lt;\/scan_line_time&gt; \r\n\t&lt;\/modem_entry&gt; \r\n&lt;\/fax_entry&gt;\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>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. &lt;!&#8211; Describes a Fax Entry &#8211;&gt; &lt;fax_entry&gt; &lt;!&#8211; URL of this fax_entry &#8211;&gt; &lt;!&#8211; value: string &#8211;&gt; &lt;fax_entry_url&gt;https:\/\/172.16.0.13\/ffws\/v1\/ofax\/00000FD1\/0000&lt;\/fax_entry_url&gt; &lt;!&#8211; URL of scheduled_fax group [&hellip;]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5419,"menu_order":29,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-5250","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5250","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/537"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=5250"}],"version-history":[{"count":7,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5250\/revisions"}],"predecessor-version":[{"id":5482,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5250\/revisions\/5482"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5419"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=5250"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}