Deciphering the Resulting Status Codes in RightFax
Summary: RightFax shows a status message for each fax in Faxutil and Webutil. To learn more about why a fax transmission may have failed, the fax history includes status codes that offer concise information. This Knowledge Base article helps to decipher these Resulting status codes.
Solution: Often, with failed faxes, information on the failure can be found in 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).
A failure to send a fax using the server computer’s telephony integration can be generally classified into one of these two categories.
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 device to the 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. This information does not yield any data about why a fax failed (that is, it does not indicate the specific reason why the communication between the two end points was unsuccessful). However, it does show what happened at the time that the fax failed.
For example, a Resulting status code of “0/339; 4/75” indicates that a 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 it does not indicate specifically why the remote side terminated the call. Therefore, since this information does not explain why the remote device terminated the call, it is more useful for identifying a behavior pattern, rather than for explaining the failure of an isolated fax call.
If you are having issues with RightFax Error Codes, or any other RightFax error, please contact us at 1-866-730-1700 or firstname.lastname@example.org
Table 1: RightFax Call Line Status
|RightFax Call Line Status||Message in History||Status in Faxutil or Webutil|
|258||Dial Er: no dial tone||Error: No Dial Tone|
|259||Dial Er: no loop current||Error: Phoneline Problem|
|260||Dial Er: local in use||Error: Line in Use|
|301||Normal Busy||Error: Busy|
|302||Normal Busy||Error: Busy|
|303||Fast Busy||Error: Busy|
|304||Recall Dial Tone||Error: Phoneline Problem|
|305||Confirmation tone||Error: Unknown Error|
|306||Pulse||Error: Unknown Error|
|308||Ringing Detected||Error: No Answer|
|309||Double Ringing Detected||Error: No Answer|
|316||Answer (probably human)||Error: Human Answered|
|317||Answered, quiet followed||Error: Human Answered|
|318||Dial tone after dialing||Error: Phoneline Problem|
|324||Silence, no signal or CNG||Error: Phoneline Problem|
|325||Ringing, no answer||Error: No Answer|
|326||Group 2 Fax Machine||Error: G2 Fax Machine|
|327||Special Info Tone||Error: Phoneline Problem|
|328||Dead line (after dialing)||Error: Human Answered|
|329||Vacant tone (invalid phone num?)||Error: Phoneline Problem|
|330||Reorder tone (PBX/Carrier failure)||Error: Busy|
|331||No circuit tone (dead line?)||Error: Phoneline Problem|
|332||CNG fax tone detected||Error: Unknown Error|
|333||Remote off-hook||Error: Unknown Error|
|334||Special CP||Error: Unknown Error|
|339||Answer Tone Detected||Success|
Table 2: Dialogic Status Types
|Call Status||Dialogic Call Status||Description|
|5||BT_STATUS_USER_TERMINATED||User function caused termination|
Table 3: Dialogic Return Codes from the Dialogic API 6.3
|BT_STATUS_ERROR||2/0||APIERR_UNCLASSIFIED||No further info provided.|
|BT_STATUS_ERROR||2/1||APIERR_FILEIO||File I/O error occurred.|
|BT_STATUS_ERROR||2/2||APIERR_FILEFORMAT||Bad file format.|
|BT_STATUS_ERROR||2/3||APIERR_BOARDCAPABILITY||Hardware or firmware does not support capability.|
|BT_STATUS_ERROR||2/4||APIERR_NOTCONNECTED||Channel not in proper state.|
|BT_STATUS_ERROR||2/5||APIERR_BADPARAMETER||Bad parameter value used.|
|BT_STATUS_ERROR||2/6||APIERR_MEMORY||Memory allocation error.|
|BT_STATUS_ERROR||2/7||APIERR_BADSTATE||The channel is not in a required state.|
|BT_STATUS_ERROR||2/8||APIERR_TOOSOON||Dialing was attempted too soon.|
|BT_STATUS_ERROR||2/10||APIERR_DRV_OPEN_ERROR||Driver open call failed, invalid channel or driver not correctly installed.|
|BT_STATUS_ERROR||2/11||APIERR_DRV_IOCTL_ERROR||Driver call failed.|
|BT_STATUS_ERROR||2/12||APIERR_VERSION||Incompatible driver version.|
|BT_STATUS_ERROR||2/13||APIERR_INVALID_PORT||Invalid port; faxinit probably not run correctly.|
|BT_STATUS_ERROR||2/14||APIERR_RINGING||Ringing during dialing attempt.|
|BT_STATUS_ERROR||2/15||APIERR_INFOPKT_NESTING||Indir infopkt nesting level too deep.|
|BT_STATUS_ERROR||2/16||APIERR_MAX_TAGS||Maximum number of TIFF tags exceeded.|
|BT_STATUS_ERROR||2/17||APIERR_LOCK_FAILED||An attempt to gain a lock failed.|
|BT_STATUS_ERROR||2/18||APIERR_INSUFF_BUFFER||Buffer size too small to receive data.|
|BT_STATUS_ERROR||2/19||APIERR_INVALID_DEST_ADDR||Destination address not found or invalid.|
|BT_STATUS_ERROR||2/20||APIERR_PACKET_CREATION||Packet or command creation error.|
|BT_STATUS_ERROR||2/21||APIERR_PACKET_PARSE||Packet or command parse error.|
|BT_STATUS_ERROR||2/22||APIERR_PACKET_SEND||Packet send error.|
|BT_STATUS_ERROR||2/23||APIERR_PACKET_RECEIVE||Packet receive error.|
|BT_STATUS_ERROR||2/24||APIERR_DATA||DATA encountered during command processing.|
|BT_STATUS_ERROR||2/25||APIERR_INVAL_BOARD_PARAM||Invalid parameter values received from firmware.|
|BT_STATUS_ERROR||2/26||APIERR_FIRMWARE_ERR_DETECTED||Firmware detected an error.|
|BT_STATUS_ERROR||2/27||APIERR_MODULE_REMOVED||Module was removed.|
|BT_STATUS_ERROR||2/28||APIERR_BOARD_NO_RESPONSE||Board not responding.|
|BT_STATUS_ERROR||2/29||APIERR_ASYNC_LP_ERR||Async_lp value error.|
If you would like to learn more or speak to one of our dedicated RightFax experts, please contact us using the request button below or call us directly at 866-730-1700.