Schedule Fax Element

Most elements under schedule_fax are optional. If an element is left out, an appropriate default or an empty string will be substituted.

<!-- Describes one or more faxes to send -->
<schedule_fax> 
<!-- Cover page information -->
	<cover_page> 
<!-- URL of cover page on server to use -->
<!-- default: default.pdf -->
<!-- required: no -->
<!-- value: string -->
		<url>https://192.168.2.1/ffws/v1/data/cover_pages/default.pdf</url> 
<!-- Enable or disable the inclusion of a cover page -->
<!-- default: true -->
<!-- required: no -->
<!-- value: boolean -->
		<enabled>true</enabled> 
<!-- Subject added to subject field on cover page -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<subject>Test Subject</subject> 
<!-- Message added to the comments field on cover page -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<comments>Test Message</comments> 
	</cover_page> 
<!-- Sender information -->
	<sender> 
<!-- The name of the sender -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<name>Sender Name</name> 
<!-- Sender Organization/company -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<organization>Sender Org</organization> 
<!-- Sender phone number -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<phone_number>218-555-3333</phone_number> 
<!-- Sender fax number -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<fax_number>218-555-3334</fax_number> 
<!-- Sender email address-->
<!-- This field must be included to receive email alerts -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<email_address>sender@Example.com</email_address> 
	</sender> 
<!-- Recipient information -->
<!-- At least one recipient must be included -->
<!-- A fax is sent to each recipient -->
	<recipient> 
<!-- Recipient Name -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<name>Rcpt 1 Name</name> 
<!-- Recipient Organization -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<organization>Rcpt 1 Org</organization> 
<!-- Recipient Fax Number -->
<!-- The fax number to send to -->
<!-- required: yes -->
<!-- value: string -->
		<fax_number>218-555-3335</fax_number> 
<!-- Recipient Phone Number -->
<!-- default: “” -->
<!-- required: no -->
<!-- value: string -->
		<phone_number>218-555-3336</phone_number> 
	</recipient> 
<!-- Attachments to send as fax pages -->
	<attachment> 
<!-- Attachment location -->
<!-- required: yes -->
<!-- value: inline | external -->
		<location>inline</location> 
<!-- Attachment name -->
<!-- A unique name associate with this attachment -->
<!-- Used to differentiate between attachments -->
<!-- required: yes if location == inline -->
<!-- value: string -->
		<name>attachment1.txt</name> 
<!-- Attachment type must be one of: -->
<!-- application/pdf -->
<!-- application/postscript -->
<!-- text/plain -->
<!-- image/tiff -->
<!-- required: yes if location == inline -->
<!-- value: string -->
		<content_type>text/plain</content_type> 
<!-- Content encoding -->
<!-- Must be set to base64 -->
<!-- required: yes if location == inline -->
<!-- value: string -->
		<content_transfer_encoding>base64</content_transfer_encoding> 
<!-- Content of attachment base64 encoded -->
<!-- required: yes if location == inline -->
<!-- value: string -->
		<content>dGVzdA==</content> 
<!-- HTTP URL of attachment hosted on another web server -->
<!-- required: yes if location == external -->
<!-- value: string -->
		<url>http://Example.com/fax/report.pdf</url> 
	</attachment> 
<!-- Maximum number of tries until failure of fax -->
<!-- default: 3 -->
<!-- required: no -->
<!-- value: integer -->
	<max_tries>3</max_tries> 
<!-- Priority level of fax -->
<!-- Must be of value from 0..5 where 0 is the highest -->
<!-- A higher priority fax will send before a lower priority fax -->
<!-- when there is more than one fax ready to send. -->
<!-- default: 3 -->
<!-- required: no -->
<!-- value: integer -->
	<priority>3</priority> 
<!-- Interval in seconds between failure tries -->
<!-- default: 30 -->
<!-- required: no -->
<!-- value: integer -->
	<try_interval>30</try_interval> 
<!-- Fax Receipt -->
<!-- Send a fax receipt to senders email: “always” | “never” | “failure” -->
<!-- default: “failure” -->
<!-- required: no -->
<!-- value: string -->
	<receipt>failure</receipt> 
<!-- Fax Attachment with Receipt -->
<!-- Send the fax pages as an attachment with receipt: “pdf” | “tiff” | “none” -->
<!-- default: “pdf” -->
<!-- required: no -->
<!-- value: string -->
	<receipt_attachment>none</receipt_attachment> 
<!-- URL of scheduled faxes -->
<!-- Added by FFWS -->
<!-- value: string -->
	<fax_url>https://192.168.2.1/ffws/v1/ofax/0000001C</fax_url> 
<!-- Total number of fax pages not including the cover page -->
<!-- Added by FFWS -->
<!-- value: integer -->
	<pages>1</pages> 
<!-- Schedule all faxes to send at a specified UTC time -->
<!-- If this options is not present then faxes will be -->
<!-- scheduled to send as soon as possible. -->
<!-- Format: %FT%T -->
<!-- required: no -->
<!-- value: string -->
	<schedule_all_at>2008-08-07T20:30:00</schedule_all_at> 
</schedule_fax>