Deciphering the Resulting Status Codes in RightFax

This article applies to the following versions:

RightFax 23.4, 22.2, 21.2, 20.2, 16.6 & Earlier

See RightFax Product Lifecycle >>>

Summary

OpenText Fax (RightFax) shows a status message for each fax in FaxUtil and FaxUtil Web. To learn more about why a fax transmission may have failed, the fax history includes status codes that offer concise information.

Resolution

Deciphering the Resulting Status Codes in RightFax

Often, with failed faxes, information on the failure can be found in the history of the transmission record for the fax.

Resulting Status Codes:

RightFax shows the line status and the fax status for T.30 (PSTN) and T.38 (FOIP) fax transmissions. These status messages can be useful in analyzing fax errors and in helping to determine the nature of a failure (to assist with issue resolution).

However, these status messages, in conjunction with troubleshooting the telephony integration, can be useful in determining the nature of failures. As the success or failure of a fax transmission is entirely dependent on the telephony transport being used, these status messages can help to determine the underlying deficiency in end-to-end communication and can be used effectively to isolate an issue when combined with further troubleshooting and error reporting in the telephony network itself.

Interpreting the Resulting Status Codes:

The fax history shows a Resulting fax status code. Both the first and second sets of numbers are gathered by the Brooktrout API to report on the call progress (reflected in the first set of numbers before the semi-colon) and the fax progress (reflected in the second set of numbers after the semi-colon). The text that comes after the Resulting Status Code may display the same message for different numeric status code values, such as “Receive failure (Phase B)”. This is because different failure codes can be classified under the same heading, such as errors that occur during Phase B of the T.30 fax call.

Call Setup Failures

Call setup failures occur when a call cannot be successfully placed to a dialed number. The first set of numbers can be helpful in determining call setup failures. This is especially true with Analog, Analog DID, BRI, and T1 integrations. For FoIP (either TR1034 ethernet enabled fax boards or SR140 “Boardless” fax boards), the Wireshark Network capture utility is considerably more useful for troubleshooting call setup errors.

First Set of Numbers – Call Progress Status

The first set of numbers represents the RightFax call status and the call line status. The first number is typically zero (“0”) and means that the call was placed. The second number can be found in Table 1 below.

Second Set of Numbers – Fax Progress Status

(This is generally where transmission failures are reflected!)

Transmission errors occur when a call is successfully placed from the fax server to the end point fax device (or from an end point sending devices to fax server), but the overall quality of the connection between the two end points is insufficient to convey the fax data effectively to or from the remote device. The Second set of numbers in the resulting status code reflects the outcome of the fax transmission. the information does not contain any data about why a fax failed (that is, it does not indicate the specific reason why the communications between the two end points was unsuccessful). However, it does show what happed at the time that the fax failed.

For example, a Resulting status code of “0/399;4/75” indicates that a Disconnect (DCN) message was received from the remote device (a DCN is the signal sent from a T.30 device that states “I’m disconnecting”). This information indicates that the remote side terminated the call, but does not indicate why the remote side terminated the call. Therefore, since this information does not explain why the device terminated the call, it is more useful for identifying a behavior pattern, rather than explaining the failure of an isolated fax call.

See Glossary of terms for the abbreviations within the error code descriptions.

Table 1: RightFax Call Line Status

** If the status in FaxUtil shows “Transmission Error” and the Resulting Status Code in Fax History shows 0/339 in the first two digits, then one or both of the third and fourth digits will have values greater than 0. In this case, the phone call was answered (code 339) but failed at some point afterward. Match the 3rd and 4th digits of the Resulting Status Code (e.g. 4/27 in the code 0/339;4/27) to their corresponding values in tables two and three respectively.

Table 2: Dialogic Status Types

Table 3: Dialogic Return Codes from the Dialogic API 6.3

Table 4: Resulting Status

Table 5: Line Status

NOTE: The SEND_FAILURE_PASS# defines an attempt to send a fax in which a failure occurs.

• PASS1 is the first send failure to the specified number.
• PASS2 is the second failure to the specified number, and so on, in which case a PSTN retry occurs.

Glossary of Terms

Additional Information

To view a list of Brooktrout Return Codes, see the following: Brooktrout Bfv APIs Reference Manual

If this list is unavailable, search the Enghouse Customer Supporet website for ref_apiset.pdf: Enghouse Customer Support

For more information on fax statuses, see the Webutil help topic “Fax Status Messages.”
To view a list of Dialogic return codes, see the following:

http://www.cantata.com/support/download/Brooktrout%20Return%20Error%20Codes.rtf

OR

http://www.dialogic.com/webhelp/Brooktrout/SDK62/ref_apiset.pdf

If this list is unavailable, search the Dialogic website for ref_apiset.pdf:

http://www.dialogic.com

For values related to RightFax Connect, see:

http://www.dialogic.com

Need Additional Help?

We're here to help! If there is anything we can do for you, please contact us through our Support Portal and we will reach out.