ReplixFax supports notifying via HTTP(S) POST when a new fax has arrived or when an outgoing fax has been sent or has failed. The parameters in the POST contain the fax id and other relevant metadata. Once notification is received, the SOAP API can be used to retrieve the fax content or additional metadata. In the event that the recipient of the POST is unavailable, the ReplixFax service will attempt to send the POST message 12 times and wait 2 hours between each attempt.
The POSTs can come from the following IP addresses:
Below is a list of the data received in the parameters of a notification post when a new fax has arrived. Click here to see an example of a POST request.
| CallerNumber | Calling party number, if available. Max size: 24 characters. |
| DestFaxNumber | Destination fax number represents the number that was dialed by the sender or a fax number associated with the fax line. Max size: 50 characters. |
| Duration | Number of seconds it took to receive the fax. |
| ErrorCode | Numeric status of the error encountered, 0 – for no error, specific to the fax server backend. |
| ErrorText | Text string corresponding to ErrorCode, empty for no error. Max Size: 255 characters. |
| FaxId | Unique Fax identifier. |
| FaxStatus | "recvOk" or "recvIncomplete" |
| FaxUserId | ID of the user that received the fax. Max size: 16 characters. |
| PagesReceived | Number of pages received. |
| Queue | "ReceiveFax" |
| ReceivedTime | Date and time fax was received. Format: YYYY-MM-DDTHH:MM:SSZ |
| Realm | Unique identifier for your organization. Max size: 32 characters. |
| TSI | Transmitting Station Identifier Max size: 50 characters. |
Below is a list of the data received in the parameters of a notification post when an outgoing fax has been sent or cannot be sent. Click here to see an example of a POST request.
| CSI | Called Station Identifier Max size: 50 characters. |
| CompleteTime | Date/time fax was completed (fax is completed when it reaches status of "sent" or "sendFailed") or last updated (fax status is other than final). Format: YYYY-MM-DDTHH:MM:SSZ |
| Duration | Number of seconds it took to send the fax. |
| ErrorCode | Numeric status of the error encountered, 0 – for no error, specific to the fax server backend. |
| ErrorText | Text string corresponding to ErrorCode, empty for no error. Max size: 255 characters. |
| FaxId | Unique Fax identifier |
| FaxNumber | Outgoing fax number. Max size: 50 characters. |
| FaxStatus | "sent" or "sendFailed" Max size: 24 characters. |
| FaxUserId | ID of the user that sent the fax. Max size: 16 characters. |
| PagesSent | Number of pages sent. |
| Queue | SendFax |
| Realm | Unique identifier for your organization. Max size: 32 characters |