ReceiveFAX()

Since 11.0.0 Applications

Receive a FAX and save as a TIFF/F file.

Last reviewed 2026-04-14

ReceiveFAX(filename[,options])

Dialplan Builder -- build your ReceiveFAX() command

filename

options

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

Force usage of audio mode on T.38 capable channels.

d: Enable FAX debugging.

Enable FAX debugging.

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

Allow audio fallback FAX transfer on T.38 capable channels.

s: Send progress Manager events (overrides statusevents setting in res\_fax.conf).

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

Full arguments reference

filename required
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).

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 ReceiveFAX() 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

Arguments

filename required
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).

User Notes

Know a tip or gotcha for this topic? Share it below and help others.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.

Related

If()

Start an if branch.

Applications application dialplan

Zapateller()

Generates special information tone to block telemarketers from calling you. This application will set the following chan...

Applications application dialplan

While()

Start a while loop.

Applications application dialplan

WaitUntil()

Wait (sleep) until the current time is the given epoch.

Applications application dialplan

WaitForTone()

Waits for a single-frequency tone to be detected before dialplan execution continues. WAITFORTONESTATUS - This indicates...

Applications application dialplan

MusicOnHold() ADSIProg() AELSub() AGI() AMD() AddQueueMember() AgentLogin() AgentRequest() AlarmReceiver() Answer() AttendedTransfer() AudioSocket() Authenticate() Background() BackgroundDetect() BlindTransfer() Bridge() BridgeAdd() BridgeWait() Broadcast() Busy() CELGenUserEvent() CallCompletionCancel() CallCompletionRequest() ChanIsAvail() ChanSpy() ChangeMonitor() ChannelRedirect() ClearHash() ConfBridge() ConfKick() Congestion() ContinueWhile() ControlPlayback() DAHDIAcceptR2Call() DAHDIRAS() DAHDIScan() DAHDISendCallreroutingFacility() DAHDISendKeypadFacility() DBdeltree() DISA() DateTime() DeadAGI() Dial() Dictate() Directory() DumpChan() EAGI() Echo() Else() ElseIf() EndIf() EndWhile() Exec() ExecIf() ExecIfTime() ExitIf() ExitWhile() ExtenSpy() ExternalIVR() Festival() Flash() FollowMe() ForkCDR() GetCPEID() Gosub() GosubIf() Goto() GotoIf() GotoIfTime() Hangup() HangupCauseClear() IAX2Provision() ICES() IVRDemo() If() ImportVar() Incomplete() JACK() JabberJoin() JabberLeave() JabberSend() JabberSendGroup() JabberStatus() Log() MP3Player() MSet() Macro() MacroExclusive() MacroExit() MacroIf() MailboxExists() MeetMe() MeetMeAdmin() MeetMeChannelAdmin() MeetMeCount() MessageSend() Milliwatt() MinivmAccMess() MinivmDelete() MinivmGreet() MinivmMWI() MinivmNotify() MinivmRecord() MixMonitor() Monitor() Morsecode() NBScat() NoCDR() NoOp() ODBCFinish() ODBC_Commit() ODBC_Rollback() OSPAuth() OSPFinish() OSPLookup() OSPNext() Originate() PJSIPHangup() PJSIPNotify() Page() Park() ParkAndAnnounce() ParkedCall() PauseMonitor() PauseQueueMember() Pickup() PickupChan() PlayTones() Playback() PrivacyManager() Proceeding() Progress() Queue() QueueLog() QueueUpdate() RaiseException() Read() ReadExten() ReceiveFAX() ReceiveMF() ReceiveSF() ReceiveText() Record() Reload() RemoveQueueMember() ResetCDR() RetryDial() Return() Ringing() SIPAddHeader() SIPDtmfMode() SIPRemoveHeader() SIPSendCustomINFO() SLAStation() SLATrunk() SMS() SayAlpha() SayAlphaCase() SayCountedAdj() SayCountedNoun() SayDigits() SayMoney() SayNumber() SayOrdinal() SayPhonetic() SayUnixTime() SendDTMF() SendFAX() SendImage() SendMF() SendSF() SendText() SendURL() Set() SetAMAFlags() Signal() SkelGuessNumber() SoftHangup() SpeechActivateGrammar() SpeechBackground() SpeechCreate() SpeechDeactivateGrammar() SpeechDestroy() SpeechLoadGrammar() SpeechProcessingSound() SpeechStart() SpeechUnloadGrammar() StackPop() StartMusicOnHold() Stasis() StatsD() StopMixMonitor() StopMonitor() StopMusicOnHold() StopPlayTones() StoreDTMF() StreamEcho() System() TestClient() TestServer() ToneScan() Transfer() TryExec() TrySystem() UnpauseMonitor() UnpauseQueueMember() UserEvent() VMAuthenticate() VMSayName() Verbose() VoiceMail() VoiceMailMain() VoiceMailPlayMsg() Wait() WaitDigit() WaitExten() WaitForCondition() WaitForNoise() WaitForRing() WaitForSignal() WaitForSilence() WaitForTone() WaitUntil() While() Zapateller()