send_fax
Send a fax.
Properties
send_fax
An object that accepts the following properties.
send_fax.document
URL to the PDF document to fax
send_fax.header_info
Text to add to the fax header
send_fax.identity
Station identity to report
send_fax.status_url
HTTP or HTTPS URL to deliver send fax status events. Learn more about status callbacks.
Variables
Set by the method:
- send_fax_document: (out) URL of sent document.
- send_fax_identity: (out) identity of this fax station.
- send_fax_remote_identity: (out) identity of the receiving fax station.
- send_fax_pages: (out) number of pages sent.
- send_fax_result_code: (out) fax status code.
- send_fax_result_text: (out) description of fax status code.
- send_fax_result: (out)
success|failed.
StatusCallbacks
A POST request will be sent to status_url with a JSON payload like the following:
event_type
The type of event. Always calling.call.fax for this method.
event_channel
The channel for the event, includes the SWML session ID.
timestamp
Unix timestamp (float) when the event was generated.
project_id
The project ID associated with the call.
space_id
The Space ID associated with the call.
params
An object containing fax-specific parameters.
params.call_id
The call ID.
params.node_id
The node handling the call.
params.control_id
The control ID for this fax operation.
params.fax
Fax result details.
fax.type
The type of fax operation. Always finished.
fax.params.direction
The direction of the fax (send).
fax.params.identity
The identity of this fax station.
fax.params.remote_identity
The identity of the receiving fax station.
fax.params.document
URL of the sent fax document.
fax.params.pages
Number of pages sent.
fax.params.success
Whether the fax was sent successfully.
fax.params.result
The numeric result code of the fax operation (e.g., 0 for success).
fax.params.result_text
A description of the fax result (e.g., OK).
fax.params.format
The format of the fax document. Always "pdf".
Page progress events
A separate callback is sent for each page as the fax progresses:
fax.type
Always "page" for page progress events.
fax.params.direction
The direction of the fax.
fax.params.number
The page number that was just processed.
