The <SendFax> element sends fax from your local storage. The fax to be transmitted must be in tiff format

Element Attributes

Attribute Name Description Allowed Values Default Value
header FAX header to be sent to the receiving terminal Any ASCII string up to 20 chars.
ident FAX identity to be sent to the receiving terminal (it will show up in the LCD of the terminal) Any ASCII string up to 20 chars.
action URL to be called when fax operation inishes. It can be a list of URLs separated by commas (to permit fallback in case the main URL fails to reply). It can be a Section name within the current document. This attribute is optional: if absent the processing will proceed to the next XML element.
  • header and ident are used to compose a header line at the top of each page of the fax.
  • if the file to be sent doesn't exist, call will terminate and error will be notified as Error="Cannot execute SendFax. File {{FILE}} doesn't exist"

After fax operation finishes, Basix will call the 'action' URL with the following parameters:

Parameter Description
FaxResultCode See: https://wiki.freeswitch.org/wiki/Variable_fax_result_code
FaxResultText See: https://wiki.freeswitch.org/wiki/Variable_fax_result_code
FaxOperation 'transmission' or 'reception' (but in this case, 'transmission')
FaxFilePath path of TIFF file

Examples

Example 1: simple

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<SendFax>faxes/our_products/RVT-3867-W.tiff</SendFax>
</Response>

Example 2: setting header and ident

1
2
3
4

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
	<SendFax header="Basix FaxServer" ident="0312341234">faxes/main_office_map.tiff</SendFax>
</Response>