The <ReceiveFax/> Element

This element receives a fax and saves it into your domain storage under base folder 'received_faxes'

You must inform the file path where the fax should be saved.

If the folder/subfolders where the file should be saved don't exist, they will be created automatically.

Files under received_faxes or its subfolders will be removed 30 days after reception.

Element Attributes

Attribute Name Description Allowed Values Default Value
ident DEPRECATED (used to permit to set the identity of the fax receiver in the destination fax machine display. However, it was deprected to avoid misuse. Instead we will send the Basix DID (called/calling number))
action DEPRECATED (URL to be called to get more XML instructions after fax operation completes. However, this is not guaranteed to be called because usually fax machines disconnect the call upon fax operation so we deprecated it. Instead, XML developers should assume the fax operation is the last operation in the call and the result will be notified in the CallStatus=completed event)

Fax Operation Completion Parameters

Once the call ends, if configured to do so, Basix will notify the answer_url with the following parameters:

Parameter Description
FaxOperation 'transmission' or 'reception' (in this case, 'reception')
FaxFilePath path of the tiff file
FaxResultCode Numeric value indicating the result of fax operation
FaxResultText Text value indicating the result of the fax operation

The FaxResultCode and FaxResultText will be as this:

FaxResultCode FaxResultText
0 OK
2 Timed out waiting for initial communication
3 Timed out waiting for the first message
5 The HDLC carrier did not stop in a timely manner
6 Failed to train with any of the compatible modems
13 Unexpected message received
14 Received bad response to DCS or training
15 Received a DCN from remote after sending a page
17 Received a DCN while waiting for a DIS
20 Received no response to DCS or TCF
23 Invalid ECM response received from transmitter
31 Timer T2 expired while waiting for fax page
32 Timer T2 expired while waiting for next fax page
48 Disconnected after permitted retries
49 The call dropped prematurely

Examples

Example 1 : basic

The below XML receives a fax and saves it as received_faxes/some_fax.tiff. 

1
2
3

<IVR>
  <ReceiveFax>some_fax.tiff</ReceiveFax>
</IVR>

Example 2 : saving fax under subfolders

The below XML receives a fax and saves it as received_faxes/level1/level2/level3/some_fax.tiff.

1
2
3

<IVR>
  <ReceiveFax>level1/level2/level3/some_fax.tiff</ReceiveFax>
</IVR>

Example 3: setting ident

1
2
3

<IVR>
  <ReceiveFax ident="Basix Fax Service">some_fax.tiff</ReceiveFax>
</IVR>