Understanding fax transmission status and error messages in Fax.Plus API

When using the Fax.Plus API to send faxes, you may encounter various transmission statuses or error messages. Below is a detailed guide to help you understand what these messages mean and how to address them.

Success Messages

• success: The fax was successfully sent.

Partial Transmission Messages

• partially_sent: The first pages of your document were transmitted, but the call dropped due to connection issues. The recipient may not have received all pages.
• partially_received: The initial pages were received, but the call dropped due to connection issues from the recipient's side.

Credit-Related Messages

• insufficient_credit: There is not enough credit to send or receive faxes. Please add credit or wait for the next plan reset date.

General Errors

• failed: A generic error message. Please retry. If the issue persists, contact support.
• failed_internal_process_error: An internal process error occurred. Retry the fax transmission. If it continues, contact support.

Communication-Related Errors

• failed_user_busy: The recipient's fax line is busy. Wait a few minutes and try again.
• failed_no_answer: The recipient did not answer the call. Ensure the receiving fax machine is on auto-answer or try again when you know they are available.

Number and Format Errors

• failed_unallocated_number: The fax number is invalid. Double-check the number, including the correct country and area code.
• failed_invalid_number_format: The format of the fax number is incorrect. Ensure the number includes the proper country and area code.
• failed_destination_not_supported: The destination fax number is associated with a special service not supported by Fax.Plus, or your plan doesn't cover this destination.

File Conversion and Format Errors

• failed_office_converter_issue: The Microsoft Office document could not be converted, possibly due to corruption. Recreate the file and resubmit it.
• failed_separate_file_pages_issue: A file conversion issue occurred. Check if all pages in your source file are valid.
• failed_render_header_issue: The file's header could not be processed. Validate your file and retry.
• failed_mimetype_not_supported: The file type is unsupported. Convert your document into a supported format (e.g., PDF).
• failed_convert_to_tiff_issue: The conversion to TIFF format failed. Ensure all pages in your file are valid.
• failed_unknown_converter_issue: The file could not be converted, possibly due to password protection. Fax.Plus does not support faxing password-protected files.

System and Network Errors

• failed_to_send: The system was busy. Try sending your fax again later.
• failed_image_preparation: There was an issue with preparing the file for sending. Validate your file's integrity before retrying.
• failed_normal_temporary_failure: A temporary failure in the telecom network occurred. Retry your fax immediately.
• failed_normal_clearing: The call was initiated, but the recipient's line was busy. Wait a few minutes before resending the fax.

Fax Transmission Errors

• failed_fs_49: The remote fax machine disconnected unexpectedly. The recipient may have printed the pages that were already transmitted. Verify with them.
• failed_fs_2: A call was made to the destination, but no fax machine responded, or the call was picked up but the start button on the fax machine was not pressed.