Skip to main content

send_fax

Send a fax.

Parameters

NameTypeDescription
documentstringRequired URL to the PDF document to fax.
header_infostringOptional text to add to the fax header. Default is not set.
identitystringOptional station identity to report. Default is the caller ID number.

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.

Examples

Send a fax and post a result to a webhook

version: 1.0.0
sections:
main:
- send_fax: https//example.com/fax_to_send.pdf
- execute: https://example.com/handle_outgoing_fax_result