API ReferenceDiscussions

Sending Faxes

Sending faxes with the integration module.

Suggest Edits

To send a fax to a recipient, simply create a FaxJob (XML document) using the following syntax and place the file into a directory monitored by the EIM. Once files are placed in a drop directory monitored by the EIM, they will be immediately processed and delivered to the scheduler for delivery.

<?xml version="1.0"?>
<FaxJob>
	<Recipient></Recipient>
	<Attachment></Attachment>
	<LocalId></LocalId>
	<CallerId></CallerId>
	<Tag></Tag>
	<TZ></TZ>
</FaxJob>

📘

Creating Job Files and Attachments

When creating a job file and placing it in the drop directory for service, make certain that the attachment file referenced is previously created or available before writing the job file. The EIM will quickly service the job file and fail if the attachment is not available.

FaxJob Field Descriptions

NameTypeDescription
RecipientstringSpecifies the number to be dialed. This may be a long distance human readable number or E.164 (+18005551234) format.
AttachmentStringSpecifies the fully qualified file name to transmit to the recipient. This file may be a fax TIFF image (Class F) or a PDF document.
LocalIdstring(Optional) Sets the fax id (CSID) for the send request. This is the fax CSID displayed by the remote fax system. This field supports up to 21 characters.
CallerIdstring(Optional) Sets the caller id for this send request. Where possible, this number will appear as the calling party/id to the remote system. For maximum effectiveness within carrier networks, a "toll" DID is highly recommended.
TagstringTag (Optional) Sets a user-defined string associated with the fax request. This string will appear in FaxStatus responses making it easier for applications to track their fax messages. This field supports up to 32 characters.
TZstringSpecifies the time zone offset of the originator. However, this parameter also supports Linux style time zones such as "America/Chicago", "America/New_York", etc.

📘

Attachment File Deletion

By default, files pointed to by the Attachment parameter remain intact once the fax job has been processed. If the Attachment is to be deleted once the job completes, you may add the "deleteWhenDone" attribute to the Attachment node as follows:

<Attachment deleteWhenDone="1"></Attachment>

If this attribute is missing, the default behavior does not delete the attachment file specified.

Sending to Multiple Recipients

When creating a fax document intended for multiple recipients, you may create a node in the XML document that contains one or more nodes. The EIM will process multiple recipients and create a status for each recipient when completed.

<?xml version="1.0"?>
<FaxJob>
	<Recipients>
		<Recipient>...</Recipient>
		<Recipient>...</Recipient>
		<Recipient>...</Recipient>
	</Recipients>
	<Attachment deleteWhenDone="0"></Attachment>
	<LocalId></LocalId>
	<CallerId></CallerId>
	<Tag></Tag>
	<TZ></TZ>
</FaxJob>

As each fax completes, a status notification file will be written using the following format:

<!-- fax status (one per recipient) -->
<FaxStatus>
	<JobId></JobId>
	<CompletedOn></CompletedOn>
	<FaxResult></FaxResult>
	<Recipient></Recipient>
	<PagesDelivered></PagesDelivered>
	<ConnectTime></ConnectTime>
	<ConnectSpeed></ConnectSpeed>
	<RemoteId></RemoteId>
	<Tag></Tag>
</FaxStatus>

Updated almost 6 years ago

What’s Next