receive_fax
receive_fax
SignalWire Docsreceive_fax
Receive a fax being delivered to this call.
An object that accepts the following properties.
HTTP or HTTPS URL to deliver receive fax status events. Learn more about status callbacks.
Set by the method:
success | failed.A POST request will be sent to status_url with a JSON payload like the following:
The type of event. Always calling.call.fax for this method.
The channel for the event, includes the SWML session ID.
Unix timestamp (float) when the event was generated.
The project ID associated with the call.
The Space ID associated with the call.
An object containing fax-specific parameters.
The call ID.
The node handling the call.
The control ID for this fax operation.
Fax result details.
The type of fax operation. Always finished.
The direction of the fax (receive).
The identity of this fax station.
The identity of the sending fax station.
URL of the received fax document.
Number of pages received.
Whether the fax was received successfully.
The numeric result code of the fax operation (e.g., 0 for success).
A description of the fax result (e.g., OK).
The format of the fax document. Always "pdf".
A separate callback is sent for each page as the fax progresses:
Always "page" for page progress events.
The direction of the fax.
The page number that was just processed.
In this example, when a fax is received, a POST request will be sent to the URL with all
the fax related variables (like receive_fax_document) already set.
Refer to the execute statement’s documentation for more details on this behavior.