send_fax

Send a fax.

Name	Type	Default	Description
send_faxRequired	object	-	An object that accepts the send_fax parameters.

send_fax parameters

Name	Type	Default	Description
documentRequired	string	-	URL to the PDF document to fax
header_infoOptional	string	-	Text to add to the fax header
identityOptional	string	Calling party's caller ID number	Station identity to report
status_urlOptional	string	-	HTTP or HTTPS URL to deliver send fax status events.

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

YAML

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

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "send_fax": {
          "document": "https//example.com/fax_to_send.pdf"
        }
      },
      {
        "execute": {
          "dest": "https://example.com/handle_outgoing_fax_result"
        }
      }
    ]
  }
}