API | Phaxio

API
- Send related calls
- Send a fax
- Send fax callback
- Batching and collision avoidance
- String data rendering
- Receive related calls
- Test Receive
- Receive fax callback
- PhaxCodes and Hosted Documents
- Intro to PhaxCodes
- Attach PhaxCode To PDF
- Create PhaxCode
- Get Hosted Document
- Phone number calls
- Provision a number
- Release a number
- List numbers
- General calls
- Get an image thumbnail or PDF file for a fax
- List faxes in date range
- Get status for a specific faxId
- Cancel a fax
- Get account status
Client Libraries
Objects
Paging
Error Codes
HIPAA Compliance
Billing

Receive fax callback

When a fax is received, Phaxio will post information about the fax (including any metadata received from PhaxCodes) along with a PDF of the fax to your receive fax callback URL, if one is available. You can set up a receive callback URL on the callbacks page in the web console, or define URLs individually per phone number.

If you've specified a global callback URL on the callbacks page and also specify one on a phone number, the phone number's callback URL will override the global one.

Request parameters:

Name	Type	Description
is_test	boolean	Is this callback as a result of a test call?
direction	string	The direction of the fax (in this case, 'received'). Useful if you use the same callback URL for both sent and receive confirmations.
fax	Fax Object	The job's fax object.
metadata	string	The metadata associated with the PhaxCode that you specified.