receive_fax
Receive a fax being delivered to this call.
Parameters
None
Variables
Set by the method:
- receive_fax_document: (out) URL of received document.
- receive_fax_identity: (out) identity of this fax station.
- receive_fax_remote_identity: (out) identity of the sending fax station.
- receive_fax_pages: (out) number of pages received.
- receive_fax_result_code: (out) fax status code.
- receive_fax_result_text: (out) description of fax status code.
- receive_fax_result: (out)
success
|failed
.
Examples
Receive a fax and post a result to a webhook
- YAML
- JSON
version: 1.0.0
sections:
main:
- receive_fax
- execute: https://example.com/handle_incoming_fax
{
"version": "1.0.0",
"sections": {
"main": [
"receive_fax",
{
"execute": "https://example.com/handle_incoming_fax"
}
]
}
}