This guide will instruct you on how to get started using the Fax API. Before you can start sending and receiving faxes, you need to complete some basic configuration steps.
Let's get started!
Using the Fax API requires signing up for a free account on the Sinch Build Dashboard. If you haven't already done so, sign up now!
Get your project ID and create your access key: First, you'll need your project ID, which can be found in the Sinch Build Dashboard under Setting, then Projects.
Then, create your access key. Access keys are used to authenticate calls when using Numbers API. Access keys are generated in the Sinch Build Dashboard.
Make sure you have your access key, access key secret, and project ID readily available. This information will be required when making the API call to send the text message. The access key and access key secret must be recorded during access key creation. The project ID can be found on the Sinch Build Dashboard's Project Settings page.
The client ID will be readily visible. The secret ID, however, will only be visible upon new key creation. Create a new key and then save your secret ID in a safe place.
You will need both the client ID and the client secret for most endpoints in the Numbers API.
To receive faxes, we recommend buying a Sinch number. This number can then receive faxes so you can easily get started sending and receiving faxes right away.
To configure it to use with the Fax API, in your dashboard select the number you want and under the Voice Configuration section ensure you have selected Fax. You can also assign a number to your default Fax service so you're ready to go.
Now you're ready to start sending faxes with the API. The payload to send a fax is below:
{
"to": "YOUR_fax_number",
"contentUrl": "https://developers.sinch.com/fax/fax.pdf"
}This payload sends a sample PDF to the specified number. The placeholder values included in the payload above are detailed in the table below:
| Placeholder value | Your value |
|---|---|
| YOUR_fax_number | This is a number you own that can receive faxes. Make sure it's in E.164 format with the leading +. |
If you already have experience making API calls, you could create a simple app that sends the fax in your preferred coding language, or even make a simple cURL command. Use the payload to make a POST API call to https://fax.api.sinch.com/v3/projects/{projectId}/faxes, where {projectId} is replaced with your project ID. Include authentication information in the header. Since this guide is intended for testing purposes, you can use your application key and application secret to authenticate using basic authentication, but for production we recommend using a stronger method of authentication, like OAuth 2.0.
Alternatively, these guides will walk you through setting up a simple application in the following languages (make sure you bring all the information you gathered during this process!):
