send_fax
send_fax
SignalWire Docssend_fax
Send a fax.
An object that accepts the following properties.
URL to the PDF document to fax
Text to add to the fax header
Station identity to report
HTTP or HTTPS URL to deliver send 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 (send).
The identity of this fax station.
The identity of the receiving fax station.
URL of the sent fax document.
Number of pages sent.
Whether the fax was sent 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.