{"id":4875,"date":"2025-02-05T13:25:22","date_gmt":"2025-02-05T19:25:22","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=4875"},"modified":"2025-02-05T13:27:42","modified_gmt":"2025-02-05T19:27:42","slug":"scheduling-a-fax","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/faxing-apis\/scheduling-a-fax\/","title":{"rendered":"Scheduling a Fax"},"content":{"rendered":"<p><P>An application can schedule a fax by posting the schedule fax XML to the ofax resource. If the fax is scheduled successfully, a response is returned with the scheduled entries.  <\/P><\/p>\n<p><FONT color=\"#006FC0\"><B>Notes:<\/b><\/font> <\/p>\n<ul>\n<li>Place each file that you want to attach as fax pages in an attachment element. <\/li>\n<li>Inline attachments are attachments with the file contents inserted in the content tag. <\/li>\n<li>Use base64 to encode inline attachments.\t<\/li>\n<li>Unless the file basename is not unique among the attachments, the attachment name can usually be set to the file basename.<\/li>\n<li>The name is used primarily for error responses, so if you want to know which attachment failed, make this field unique. <\/li>\n<p><P>Set the attachment content type to match the type of the file being transferred. For Example, if attaching a PDF, set the content type to &ldquo;application\/pdf&rdquo;. FaxFinder uses content type to convert the file into fax pages. It does not attempt to guess the content type. <\/P><\/p>\n<table border=1 cellspacing=0 cellpadding=0 width=550 style='border-collapse:collapse;border:none'>\n<tr>\n<td width=150 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p> Limits<\/p>\n<\/td>\n<td width=400 colspan=2 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>Request size: 36MB<\/p>\n<p>Maximum Recipients per Fax: 400<\/p>\n<\/td>\n<\/tr>\n<tr>\n<td width=150 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>Query Parameters<\/p>\n<\/td>\n<td width=400 colspan=2 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>None<\/p>\n<\/td>\n<\/tr>\n<tr>\n<td width=150 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>HTTP Request Line<\/p>\n<\/td>\n<td width=400 colspan=2 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>POST \/ffws\/v1\/ofax HTTP\/1.1<\/p>\n<\/td>\n<\/tr>\n<tr>\n<td width=150 rowspan=2 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>HTTP Response Status Codes<\/p>\n<\/td>\n<td width=125 valign=top style='border:solid #4F81BD 1.0pt;padding:0in .01in 0in .01in'>\n<p>201 Created<\/p>\n<\/td>\n<td width=275 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>The fax has been created successfully.<\/p>\n<\/td>\n<\/tr>\n<tr>\n<td width=125 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>400 Bad Request<\/p>\n<\/td>\n<td width=275 valign=top style='border:solid #4F81BD 1.0pt; padding:0in .01in 0in .01in'>\n<p>Invalid request. The fax has not been scheduled. The response message may provide more details.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n<p><P>Set the attachment content type to match the type of the file being transferred. For Example, if attaching a PDF, set the content type to &ldquo;application\/pdf&rdquo;. FaxFinder uses content type to convert the file into fax pages. It does not attempt to guess the content type. <\/P><\/p>\n<h4>Example<\/h4>\n<pre class=\"brush:xml\">POST \/ffws\/v1\/ofax HTTP\/1.1  \r\ncontent-type: application\/xml  \r\nauthorization: Basic YWRtaW46YWRtaW4=  \r\n&lt;?xml version=&rdquo;1.0&rdquo; encoding=&rdquo;UTF-8&rdquo;?&gt;\r\n&lt;schedule_fax&gt; \r\n\t&lt;cover_page&gt;\r\n\t&lt;url&gt;https:\/\/192.168.2.1\/ffws\/v1\/data\/cover_pages\/default.pdf&lt;\/url&gt;\r\n\t\t&lt;enabled&gt;true&lt;\/enabled&gt; \r\n\t\t&lt;subject&gt;Test Subject&lt;\/subject&gt; \r\n\t\t&lt;comments&gt;Test Message&lt;\/comments&gt; \r\n\t&lt;\/cover_page&gt; \r\n\t&lt;sender&gt;  \r\n\t\t&lt;name&gt;Sender Name&lt;\/name&gt;\r\n\t\t&lt;organization&gt;Sender Org&lt;\/organization&gt;\r\n\t\t&lt;phone_number&gt;218-555-3333&lt;\/phone_number&gt;\r\n\t\t&lt;fax_number&gt;218-555-3334&lt;\/fax_number&gt;\r\n\t\t&lt;email_address&gt;sender@Example.com&lt;\/email_address&gt;\r\n\t&lt;\/sender&gt; \t\r\n\t&lt;recipient&gt; \r\n\t\t&lt;name&gt;Rcpt 1 Name&lt;\/name&gt; \r\n\t\t&lt;organization&gt;Rcpt 1 Org&lt;\/organization&gt;\r\n\t\t&lt;fax_number&gt;-218-555-3335&lt;\/fax_number&gt;\r\n\t\t&lt;phone_number&gt;218-555-3336&lt;\/phone_number&gt; \r\n\t&lt;\/recipient&gt; \r\n\t&lt;attachment&gt; \r\n\t\t&lt;location&gt;inline&lt;\/location&gt;  \r\n\t\t&lt;name&gt;attachment1.txt&lt;\/name&gt;  \r\n\t\t&lt;content_type&gt;text\/plain&lt;\/content_type&gt;\r\n\t\t&lt;content_transfer_encoding&gt;base64&lt;\/content_transfer_encoding&gt;\r\n\t\t&lt;content&gt;dGVzdA==&lt;\/content&gt;  \r\n\t&lt;\/attachment&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;30&lt;\/try_interval&gt;  \r\n\t&lt;receipt&gt;failure&lt;\/receipt&gt;  \r\n\t&lt;receipt_attachment&gt;none&lt;\/receipt_attachment&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-----------------------------------  \r\nHTTP\/1.1 201 Created  \r\ncontent-type: application\/xml \r\n \r\n&lt;?xml version=&rdquo;1.0&rdquo; encoding=&rdquo;UTF-8&rdquo;?&gt; \r\n&lt;response&gt;  \r\n\t &lt;message&gt;Success&lt;\/message&gt;  \r\n\t&lt;fax_entry&gt;\r\n\t&lt;fax_entry_url&gt;https:\/\/192.168.2.1\/ffws\/v1\/ofax\/0000001B\/0000&lt;\/fax_entry_url&gt; \r\n\t &lt;fax_url&gt;https:\/\/192.168.2.1\/ffws\/v1\/ofax\/0000001B&lt;\/fax_url&gt;  \r\n\t\t &lt;state&gt;preprocessing&lt;\/state&gt;  \r\n\t\t &lt;schedule_message&gt;New fax entry&lt;\/schedule_message&gt;  \r\n\t\t &lt;created&gt;2008-08-01 08:43:29&lt;\/created&gt;  \r\n\t\t &lt;stime&gt;2008-08-01 08:52:29&lt;\/stime&gt;  \r\n\t\t &lt;try_number&gt;1&lt;\/try_number&gt;  \r\n\t\t &lt;agent&gt;FFWS&lt;\/agent&gt;  \r\n\t\t &lt;preview&gt;https:\/\/192.168.2.1\/ffws\/v1\/data\/preview\/0000001B-0000.pdf&lt;\/preview&gt;  \r\n\t\t &lt;cover_page&gt;  \r\n\t\t\t &lt;url&gt;https:\/\/192.168.2.1\/ffws\/v1\/data\/cover_pages\/default.pdf&lt;\/url&gt;  \r\n\t\t\t &lt;enabled&gt;true&lt;\/enabled&gt;  \r\n\t\t\t&lt;subject&gt;Test Subject&lt;\/subject&gt;  \r\n\t\t\t &lt;comments&gt;Test Message&lt;\/comments&gt;  \r\n\t\t &lt;\/cover_page&gt;  \r\n\t\t\t &lt;sender&gt;  \r\n\t\t\t &lt;username&gt;admin&lt;\/username&gt;  \r\n\t\t\t &lt;name&gt;Sender Name&lt;\/name&gt;  \r\n\t\t\t &lt;organization&gt;Sender Org&lt;\/organization&gt;  \r\n\t\t\t &lt;phone_number&gt;218-555-3333&lt;\/phone_number&gt;  \r\n\t\t\t &lt;fax_number&gt;218-555-3334&lt;\/fax_number&gt;  \r\n\t\t\t &lt;email_address&gt;sender@Example.com&lt;\/email_address&gt;  \r\n\t\t &lt;\/sender&gt;  \r\n\t\t &lt;recipient&gt;  \r\n\t\t\t &lt;name&gt;Rcpt 1 Name&lt;\/name&gt;  \r\n\t\t\t &lt;organization&gt;Rcpt 1 Org&lt;\/organization&gt;  \r\n\t\t\t &lt;fax_number&gt;218-555-3335&lt;\/fax_number&gt;  \r\n\t\t\t &lt;phone_number&gt;218-555-3336&lt;\/phone_number&gt;  \r\n\t\t &lt;\/recipient&gt;   \r\n\t\t &lt;max_tries&gt;3&lt;\/max_tries&gt;  \r\n\t\t &lt;priority&gt;3&lt;\/priority&gt;  \r\n\t\t &lt;try_interval&gt;30&lt;\/try_interval&gt;  \r\n\t\t &lt;receipt&gt;failure&lt;\/receipt&gt;  \r\n\t\t &lt;receipt_attachment&gt;none&lt;\/receipt_attachment&gt;  \r\n\t\t &lt;pages&gt;0&lt;\/pages&gt;  \r\n\t\t &lt;approver&gt;&lt;\/approver&gt;  \r\n\t\t &lt;approval_time&gt;&lt;\/approval_time&gt;  \r\n\t&lt;\/fax_entry&gt;  \r\n &lt;\/response&gt; <\/pre>\n","protected":false},"excerpt":{"rendered":"<p>An application can schedule a fax by posting the schedule fax XML to the ofax resource. If the fax is scheduled successfully, a response is returned with the scheduled entries. Notes: Place each file that you want to attach as fax pages in an attachment element. Inline attachments are attachments with the file contents inserted [&hellip;]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5403,"menu_order":22,"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-4875","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/4875","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=4875"}],"version-history":[{"count":74,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/4875\/revisions"}],"predecessor-version":[{"id":12982,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/4875\/revisions\/12982"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5403"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=4875"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}