Send a fax with PHP
You can quickly see how the Fax API works by sending yourself a fax using the API.
In this guide you will learn:
What you need to know before you start
Before you can get started, you need the following already set up:
- Set all Fax API configuration settings.
- PHP 8.1 or later and a familiarity with how to create a new file.
Create your PHP file
Create a new file named send-fax.php and paste the provided "send-fax.php" code into the file.
Note:
This tutorial uses basic authentication for testing purposes. We recommend using OAuth token-based authentiation for production.
This code sends a fax to a specified number using the Sinch Fax API.
To
In this example you want to fax a phone number. Change the value of theto parameter to the phone number you verified in your dashboard in E.164 format.Note:
When your account is in trial mode, you can only send a fax to your verified numbers. If you want to fax any number, you need to upgrade your account!
Content URL
The Fax API can send either files directly or the URL of a web page or other online resource. For the purposes of this tutorial, use a web page because it's the easiest way to get started. Change the value ofYOUR_content_url to the URL of the web page.Note:
You can use any URL on the Internet (including ones with basic authentication), and we'll pull it down and make it a fax. This might be useful to you if you're using a web framework for templates and creating fax files.
If you are passing fax a secure URL (starting withhttps://), make sure that your SSL certificate (including your intermediate cert, if you have one) is installed properly, valid, and up-to-date.Callback URL
If you provide a callback URL on your Fax service, the Fax API can send notification events to your server about your outgoing fax, such as when or if the fax was delivered. You can set that callback URL in your request body. Change the value ofYOUR_callback_url to the URL of your server that's listening to incoming requests.Fill in your parameters
Before you can run the code, you need to update some more values so you can connect to your Sinch account. Update the following parameters with your own values:
| Parameter | Your value |
|---|---|
YOUR_project_id | The project ID found on your Sinch dashboard. |
YOUR_access_key | The access key found on your Sinch dashboard. |
YOUR_access_secret | The access secret found on your Sinch dashboard. Note: Access secrets are only available during initial key creation. |
Save the file.
Send your first fax
Now you can execute the code and send your fax. Run the following command:
php send-fax.phpYou should receive a fax to the number you specified with the web page that you configured.
Troubleshooting tip
If after running your app you receive a 5000 error response, you may have forgotten to save your file after adding your authentication values. This is an easy mistake to make! Try saving the file and running the app again.
