Skip to content

SendFAX() - [res_fax]

Synopsis

Sends a specified TIFF/F file as a FAX.

Since

11.0.0

Description

This application is provided by res_fax, which is a FAX technology agnostic module that utilizes FAX technology resource modules to complete a FAX transmission.

Session arguments can be set by the FAXOPT function and to check results of the SendFAX() application.

  • FAXSTATUS - Whether the fax transmission was successful

    • SUCCESS

    • FAILURE

  • FAXERROR - Description of what caused the fax to fail

    • MEMORY\_ERROR

    • CHANNEL PROBLEMS

  • FAXSTATUSSTRING - Detailed description of the status of the fax transmission

  • LOCALSTATIONID - Local Station ID

  • REMOTESTATIONID - Remote Station ID

  • FAXPAGES - Number of pages in the fax

  • FAXBITRATE - Bit rate of the fax transmission

  • FAXRESOLUTION - Resolution of the fax document

  • FAXMODE - Fax transmission mode

    • AUDIO

    • T38

Syntax

SendFAX([filename2[&...]],[options])
Arguments
  • filename

    • filename2[,filename2...] - TIFF file to send as a FAX.
  • options

    • d - Enable FAX debugging.

    • f - Allow audio fallback FAX transfer on T.38 capable channels.

    • F - Force usage of audio mode on T.38 capable channels.

    • s - Send progress Manager events (overrides statusevents setting in res_fax.conf).

    • z - Initiate a T.38 reinvite on the channel if the remote end does not.

See Also

Generated Version

This documentation was generated from Asterisk branch 20 using version GIT