Fax

​

Definition

A Fax is a document that you want to send to one or more recipients using the Fax.Plus system. Faxes can be in various formats such as PDF, Word, Excel, and other common file types.

​

Key Concepts

​

Sending a Fax

When sending a fax, you typically need to provide:

1. The recipient’s fax number(s)
2. The document(s) you want to send
3. Any additional options (e.g., cover page, scheduling)

​

Receiving a Fax

Fax.Plus can also receive faxes on your behalf. Received faxes are typically stored in your account and can be accessed through the API or web interface.

​

File Formats

Fax.Plus supports a wide range of file formats, including:

• Documents: DOC, DOCX, PDF, TXT, RTF
• Images: JPG, PNG, TIFF
• Spreadsheets: XLS, XLSX

​

Fax Status

After sending a fax, you can track its status. The status indicates whether the fax was successfully sent, is still in progress, or encountered an error. You can use webhooks to receive real-time updates on fax transmission status.

​

Fax Error Statuses

Fax.Plus uses a variety of error status codes to indicate the current state of a fax. Here are the possible statuses and their meanings:

Status	Description
success	The fax was successfully sent.
partially_sent	The first pages were transmitted, but the call dropped due to connection issues.
partially_received	The first pages were received, but the call dropped due to connection issues.
insufficient_credit	Not enough credit to send or receive pages. Add credit or wait for plan reset.
failed	Generic error. Retry, and contact support if the issue persists.
failed_internal_process_error	Generic error. Retry, and contact support if the issue persists.
failed_user_busy	The destination was busy. Wait and retry.
failed_no_answer	No answer at the destination. Retry when you know the recipient is available.
failed_unallocated_number	Invalid number. Check the number, including country and area codes.
failed_office_converter_issue	Failed to convert Microsoft Office document. Recreate and resubmit the file.
failed_separate_file_pages_issue	File conversion issue. Check if all pages in the source file(s) are valid.
failed_render_header_issue	File conversion issue. Check if all pages in the source file(s) are valid.
failed_invalid_number_format	Invalid number format. Check the number, including country and area codes.
failed_mimetype_not_supported	Unsupported file type.
failed_destination_not_supported	Number is a special service number or not supported by your plan.
failed_image_preparation	File conversion issue. Check if all pages in the source file(s) are valid.
failed_to_send	System was busy. Try again later.
failed_normal_temporary_failure	Temporary network issue. Retry immediately.
failed_unknown_converter_issue	File conversion failed. Check if the file is password-protected.
failed_normal_clearing	Destination was busy. Wait and retry.
failed_convert_to_tiff_issue	File conversion issue. Check if all pages in the source file(s) are valid.
failed_fs_49	Remote fax machine disconnected unexpectedly. Some pages may have been transmitted.

​

Best Practices

1. File Preparation: Ensure your files are not corrupted or password-protected before sending.
2. Number Verification: Double-check fax numbers, including country and area codes.
3. Retry Strategy: For temporary failures, implement a retry mechanism with appropriate intervals.

​

Schema