Fax Statuses
The table below describes the status codes returned by the API in fax objects.
Name | Description |
---|---|
queued |
The operation is currently in a queue on a server and should be executed very soon. |
pendingbatch |
The fax is in batching mode. It is currently open to accepting more files for its recipients. |
inprogress |
The system is in the middle of the job and communicating with the fax machine. |
success |
The fax operation succeeded. Everything went as normally planned. For a sent fax, this means all recipients received the fax successfully. |
failure |
The fax operation failed. Details of the error can be found in the error_code field. For a sent fax, this means that NONE of the recipients received the fax. |
partialsuccess |
The job partially succeeded. Details of what went wrong can be found in the error_code field. For a sent fax, this usually means that SOME of the recipients received the fax, but not all. |
Fax Recipient Statuses
At the recipient level, statuses are more granular and will give you a better idea of what is going on in a call.
Name | Description |
---|---|
queued |
The operation is currently in a queue on a server and should be executed very soon. |
pendingbatch |
The fax is in batching mode. It is currently open to accepting more files for its recipients. |
inprogress |
The system is in the middle of the job and communicating with the fax machine. |
ringing |
The line is ringing. |
callactive |
The far side has answered the call and we are transmitting your fax. |
willretry |
The last phone call has failed. Phaxio is going to wait a specified number of seconds (depending on your Fax Settings) and then try calling again. |
success |
The fax operation succeeded. Everything went as normally planned. For a sent fax, this means all recipients received the fax successfully. |
failure |
The fax operation failed. Details of the error can be found in the error_code field. For a sent fax, this means that NONE of the recipients received the fax. |
Porting Statuses
The following statuses apply to port orders and numbers.
Name | Description |
---|---|
open |
The port order has been received. |
submitted |
The order has been submitted to the provider. |
needinfo |
More information is needed to complete the port. |
succeeded |
The port has succeeded. |
failed |
The port has failed. |