Faxing; Scheduling A Fax - Multitech FaxFinder FF240-IP Developer's Manual

Faxing

Scheduling a Fax

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 in the content tag.

Use base64 to encode inline attachments.

Unless the file basename is not unique among the attachments, the attachment name can usually be set to the
file basename.

The name is used primarily for error responses, so if you want to know which attachment failed, make this field
unique.
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 "application/pdf". FaxFinder uses content type to convert the file into fax pages. It does
not attempt to guess the content type.
Limits
Query Parameters
HTTP Request Line POST /ffws/v1/ofax HTTP/1.1
HTTP Response
Status Codes
Example
1 POST /ffws/v1/ofax HTTP/1.1
2 content-type: application/xml
3 authorization: Basic YWRtaW46YWRtaW4=
4 <?xml version="1.0" encoding="UTF-8"?>
5 <schedule_fax>
6 <cover_page>
7 <url>https://192.168.2.1/ffws/v1/data/cover_pages/default.pdf</url>
8 <enabled>true</enabled>
9 <subject>Test Subject</subject>
10 <comments>Test Message</comments>
11 </cover_page>
12 <sender>
13 <name>Sender Name</name>
14 <organization>Sender Org</organization>
15 <phone_number>218-555-3333</phone_number>
16 <fax_number>218-555-3334</fax_number>
17 <email_address>sender@Example.com</email_address>
18 </sender>
19 <recipient>
20 <name>Rcpt 1 Name</name>
21 <organization>Rcpt 1 Org</organization>
22 <fax_number>-218-555-3335</fax_number>
FaxFinder Web Services API Developer Guide
Request size: 36MB
Maximum Recipients per Fax: 400
None
201 Created The fax has been created successfully.
400 Bad Request Invalid request. The fax has not been scheduled. The response
message may provide more details.
FAXING
6