{"id":5221,"date":"2014-02-13T12:44:23","date_gmt":"2014-02-13T18:44:23","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=5221"},"modified":"2014-02-13T16:26:14","modified_gmt":"2014-02-13T22:26:14","slug":"schedule-fax-element","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/faxfinder-information-apis-and-elements\/schedule-fax-element\/","title":{"rendered":"Schedule Fax Element"},"content":{"rendered":"<p>Most elements under schedule_fax are optional. If an element is left out, an appropriate default or an empty string will be substituted.<\/p>\n<pre class=\"brush:xml\">\r\n&lt;!-- Describes one or more faxes to send --&gt;\r\n&lt;schedule_fax&gt; \r\n&lt;!-- Cover page information --&gt;\r\n\t&lt;cover_page&gt; \r\n&lt;!-- URL of cover page on server to use --&gt;\r\n&lt;!-- default: default.pdf --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;url&gt;https:\/\/192.168.2.1\/ffws\/v1\/data\/cover_pages\/default.pdf&lt;\/url&gt; \r\n&lt;!-- Enable or disable the inclusion of a cover page --&gt;\r\n&lt;!-- default: true --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: boolean --&gt;\r\n\t\t&lt;enabled&gt;true&lt;\/enabled&gt; \r\n&lt;!-- Subject added to subject field on cover page --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;subject&gt;Test Subject&lt;\/subject&gt; \r\n&lt;!-- Message added to the comments field on cover page --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;comments&gt;Test Message&lt;\/comments&gt; \r\n\t&lt;\/cover_page&gt; \r\n&lt;!-- Sender information --&gt;\r\n\t&lt;sender&gt; \r\n&lt;!-- The name of the sender --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;name&gt;Sender Name&lt;\/name&gt; \r\n&lt;!-- Sender Organization\/company --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;organization&gt;Sender Org&lt;\/organization&gt; \r\n&lt;!-- Sender phone number --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;phone_number&gt;218-555-3333&lt;\/phone_number&gt; \r\n&lt;!-- Sender fax number --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;fax_number&gt;218-555-3334&lt;\/fax_number&gt; \r\n&lt;!-- Sender email address--&gt;\r\n&lt;!-- This field must be included to receive email alerts --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;email_address&gt;sender@Example.com&lt;\/email_address&gt; \r\n\t&lt;\/sender&gt; \r\n&lt;!-- Recipient information --&gt;\r\n&lt;!-- At least one recipient must be included --&gt;\r\n&lt;!-- A fax is sent to each recipient --&gt;\r\n\t&lt;recipient&gt; \r\n&lt;!-- Recipient Name --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;name&gt;Rcpt 1 Name&lt;\/name&gt; \r\n&lt;!-- Recipient Organization --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;organization&gt;Rcpt 1 Org&lt;\/organization&gt; \r\n&lt;!-- Recipient Fax Number --&gt;\r\n&lt;!-- The fax number to send to --&gt;\r\n&lt;!-- required: yes --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;fax_number&gt;218-555-3335&lt;\/fax_number&gt; \r\n&lt;!-- Recipient Phone Number --&gt;\r\n&lt;!-- default: \u201c\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;phone_number&gt;218-555-3336&lt;\/phone_number&gt; \r\n\t&lt;\/recipient&gt; \r\n&lt;!-- Attachments to send as fax pages --&gt;\r\n\t&lt;attachment&gt; \r\n&lt;!-- Attachment location --&gt;\r\n&lt;!-- required: yes --&gt;\r\n&lt;!-- value: inline | external --&gt;\r\n\t\t&lt;location&gt;inline&lt;\/location&gt; \r\n&lt;!-- Attachment name --&gt;\r\n&lt;!-- A unique name associate with this attachment --&gt;\r\n&lt;!-- Used to differentiate between attachments --&gt;\r\n&lt;!-- required: yes if location == inline --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;name&gt;attachment1.txt&lt;\/name&gt; \r\n&lt;!-- Attachment type must be one of: --&gt;\r\n&lt;!-- application\/pdf --&gt;\r\n&lt;!-- application\/postscript --&gt;\r\n&lt;!-- text\/plain --&gt;\r\n&lt;!-- image\/tiff --&gt;\r\n&lt;!-- required: yes if location == inline --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;content_type&gt;text\/plain&lt;\/content_type&gt; \r\n&lt;!-- Content encoding --&gt;\r\n&lt;!-- Must be set to base64 --&gt;\r\n&lt;!-- required: yes if location == inline --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;content_transfer_encoding&gt;base64&lt;\/content_transfer_encoding&gt; \r\n&lt;!-- Content of attachment base64 encoded --&gt;\r\n&lt;!-- required: yes if location == inline --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;content&gt;dGVzdA==&lt;\/content&gt; \r\n&lt;!-- HTTP URL of attachment hosted on another web server --&gt;\r\n&lt;!-- required: yes if location == external --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t\t&lt;url&gt;http:\/\/Example.com\/fax\/report.pdf&lt;\/url&gt; \r\n\t&lt;\/attachment&gt; \r\n&lt;!-- Maximum number of tries until failure of fax --&gt;\r\n&lt;!-- default: 3 --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: integer --&gt;\r\n\t&lt;max_tries&gt;3&lt;\/max_tries&gt; \r\n&lt;!-- Priority level of fax --&gt;\r\n&lt;!-- Must be of value from 0..5 where 0 is the highest --&gt;\r\n&lt;!-- A higher priority fax will send before a lower priority fax --&gt;\r\n&lt;!-- when there is more than one fax ready to send. --&gt;\r\n&lt;!-- default: 3 --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: integer --&gt;\r\n\t&lt;priority&gt;3&lt;\/priority&gt; \r\n&lt;!-- Interval in seconds between failure tries --&gt;\r\n&lt;!-- default: 30 --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: integer --&gt;\r\n\t&lt;try_interval&gt;30&lt;\/try_interval&gt; \r\n&lt;!-- Fax Receipt --&gt;\r\n&lt;!-- Send a fax receipt to senders email: \u201calways\u201d | \u201cnever\u201d | \u201cfailure\u201d --&gt;\r\n&lt;!-- default: \u201cfailure\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;receipt&gt;failure&lt;\/receipt&gt; \r\n&lt;!-- Fax Attachment with Receipt --&gt;\r\n&lt;!-- Send the fax pages as an attachment with receipt: \u201cpdf\u201d | \u201ctiff\u201d | \u201cnone\u201d --&gt;\r\n&lt;!-- default: \u201cpdf\u201d --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;receipt_attachment&gt;none&lt;\/receipt_attachment&gt; \r\n&lt;!-- URL of scheduled faxes --&gt;\r\n&lt;!-- Added by FFWS --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;fax_url&gt;https:\/\/192.168.2.1\/ffws\/v1\/ofax\/0000001C&lt;\/fax_url&gt; \r\n&lt;!-- Total number of fax pages not including the cover page --&gt;\r\n&lt;!-- Added by FFWS --&gt;\r\n&lt;!-- value: integer --&gt;\r\n\t&lt;pages&gt;1&lt;\/pages&gt; \r\n&lt;!-- Schedule all faxes to send at a specified UTC time --&gt;\r\n&lt;!-- If this options is not present then faxes will be --&gt;\r\n&lt;!-- scheduled to send as soon as possible. --&gt;\r\n&lt;!-- Format: %FT%T --&gt;\r\n&lt;!-- required: no --&gt;\r\n&lt;!-- value: string --&gt;\r\n\t&lt;schedule_all_at&gt;2008-08-07T20:30:00&lt;\/schedule_all_at&gt; \r\n&lt;\/schedule_fax&gt;\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Most elements under schedule_fax are optional. If an element is left out, an appropriate default or an empty string will be substituted. &lt;!&#8211; Describes one or more faxes to send &#8211;&gt; &lt;schedule_fax&gt; &lt;!&#8211; Cover page information &#8211;&gt; &lt;cover_page&gt; &lt;!&#8211; URL of cover page on server to use &#8211;&gt; &lt;!&#8211; default: default.pdf &#8211;&gt; &lt;!&#8211; required: no [&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-5221","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5221","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=5221"}],"version-history":[{"count":15,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5221\/revisions"}],"predecessor-version":[{"id":5486,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5221\/revisions\/5486"}],"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=5221"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}