Received Fax
This guide walks through receiving a fax with FoneAPI Programmable Fax. We include sample code for many web languages and frameworks. For other frameworks (orlanguages) you can choose to use a helper library or directly respond with FoneAPI to receive a fax.
To receive a fax, you will require:
An Incoming Phone Number configured as a fax number.
- Note: This will cause the number to be unavailable to receive calls using Programmable VoiceA FaxURL which FoneAPI will query when a fax is received.
Set Up a Phone Number for Fax
First, ensure that you have an Incoming Phone Number on your account that supports receiving faxes. The number you select should have true for the fax item in the capabilities object. Alternatively, you can check using the console:
If you don't have a fax-capable number, you'll need to first purchase one. You can either use the Available Phone Number REST API (query withFaxEnabled=true), or Console Phone Numbers Search (/console/phone-numbers/search) (check the box to search for numbers with FaxCapability) to do so.
Next, you need to configure the number's Voice Receive Mode so that the number receives faxes rather than voice calls. Again, you can use the API's incoming Phone Numbers resource (POST to the instance resource with VoiceReceiveMode=fax) or the Console. If using the Console, select the phone number you want to use from the list, and change the value of the "Accepts" dropdown box to "Faxes".
At this point, the number's VoiceURL will now behave as its FaxURL. Again, note that the number will now be unable to receive regular voice calls.