Fax

Receive

View as Markdown

The <Receive> verb tells SignalWire to receive an incoming fax, which results in the creation of a new Fax instance resource.

Faxes remain stored indefinitely. To delete a fax, use the appropriate API call from the Compatibility API.

Verb attributes

action
string

The URL to request when a fax has failed or has been received.

mediaType
stringDefaults to application/pdf

The type of media used to store fax media. Valid values are application/pdf or image/tiff.

method
stringDefaults to POST

The method attribute specifies whether the request to action is a GET or a POST. Valid values are GET or POST.

pageSize
stringDefaults to letter

The size to interpret incoming pages as. Valid values are letter, legal, or a4.

Action callback

If the verb attribute action is specified, the action callback will include the Standard Fax Request Parameters plus the following optional parameters:

ErrorCode
string

The error code provides more information on a failed fax.

ErrorMessage
string

The message explaining the reason for fax failure.

FaxStatus
string

The status of the fax.

MediaUrl
string

The media URL to request to retrieve incoming media.

NumPages
integer

The number of pages received from a successful fax.

RemoteStationId
string

The transmitting subscriber identification (TSID) reported by the fax machine that sent in the fax.

Examples

Receive a fax

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Receive action="/fax/received"/>
4</Response>

SignalWire will receive the incoming fax and provide a URL endpoint.

Store fax image

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Receive mediaType="image/tiff"></Receive>
4</Response>

This example shows that the media from the incoming fax will be stored on SignalWire’s server in TIFF format.