Fax to Email

The Emails endpoint allows you to configure the Fax to Email functionality. Fax to Email allows you to send an email and then receive a fax on your Sinch number or send a fax and have it sent to your email address. The service supports sending incoming faxes to multiple email addresses and having many numbers associated with one email address.

Setting up fax to email

You can configure fax to email in two different places:

  • In the dashboard on a number-by-number basis or by adding an email address and associating many numbers to one email address.
  • Via the API when you create a number or update a number, or by using the email endpoint to set it up directly
  • Supported fax to email file types are Word, PDF, and TIF

Fax to email example

The following example shows how to configure Fax to Email using the API:

  1. Buy a number in the dashboard and assign it to a Fax service
  2. Add your email and associate it with the number you bought in step 1.
POST https://fax.api.sinch.com/v3/projects/{projectId}/services/{serviceId}/emails
 {
    "email": "user@domain.com",
    "phoneNumbers": [
       "+14155552222"
    ]
}

Now you can use your email client with the above email address to fax.

Send a fax using email

Make sure the email address you are sending from is added to your account. You can add it in the dashboard under Fax to email or via the API.

Send an email to {PhoneNumberToSendFaxTo}@sinchfax.com with the following:

Field Description
Subject: If you have multiple phone numbers associated with the email address, enter the number you want to use. If left blank, the first number that we find will be used.
Body: By default, the email body is not used.
Attachments Add any attachments you want to fax. If you want to specify the order of pages we recommend that you create one document with all pages in the correct order and attach that document. If you attach multiple documents we will merge them into one document in the order we receive them.

Receive a fax using email

When you receive a fax, we will send you an email with the following:

Field Description
From: The number the fax was sent from, e.g. +15612600684@sinchfax.com
Subject: Fax received on {your sinch number the fax was sent to}
Body: The body will contain data such as number of pages or other relevant metadata of the fax.

There will be one PDF attachment with the fax content.

Configuring your email system for best performance

Make sure you allowlist sinchfax.com and sinch.com in your spam filter to ensure delivery to your inbox, both on client and server side. Ensure your mail server is setup correctly and not on spam lists.

Encryption

All emails are sent using TLS during transport from Sinch.

List emails for a number

List any emails for a number.

SecurityBasicAuth or OAuth2
Request
path Parameters
phoneNumber
required
string

The phone number you want to get emails for.

Example: 15612600684
id
required
string

The serviceId containing the numbers you want to list.

query Parameters
page
integer
Default: 1

The page to fetch. If not specified, the first page will be returned.

Example: page=1
pageSize
integer <= 1000
Default: 100

Number of items to return on each page. default 1000

Example: pageSize=20
Responses
200

A list of emails associated with the number.

Response Schema: application/json
emails
Array of strings <email>

List of emails numbers

page
integer

Current page

totalPages
integer

Total number of pages.

pageSize
integer

Number of items per page.

totalItems
integer <int32>

Total size of the result.

get/services/{id}/numbers/{phoneNumber}/emails
Request samples
Response samples
application/json
{
  • "emails": [
    • "user@example.com"
    ],
  • "page": 0,
  • "totalPages": 0,
  • "pageSize": 0,
  • "totalItems": 0
}

List emails

List emails for the project.

SecurityBasicAuth or OAuth2
Request
path Parameters
serviceId
required
string

The serviceId containing the emails you want to list.

query Parameters
page
integer
Default: 1

The page to fetch. If not specified, the first page will be returned.

Example: page=1
pageSize
integer <= 1000
Default: 100

Number of items to return on each page.

Example: pageSize=20
Responses
200

A list of emails associated with the project.

Response Schema: application/json
Array of objects (Email)

List of emails

page
integer

Current page

totalPages
integer

Total number of pages.

pageSize
integer

Number of items per page.

totalItems
integer <int32>

Total size of the result.

get/services/{serviceId}/emails
Request samples
Response samples
application/json
{
  • "emails": [
    • {
      }
    ],
  • "page": 0,
  • "totalPages": 0,
  • "pageSize": 0,
  • "totalItems": 0
}

Add an email

Add an email to the specified service to be used for sending and receiving faxes. Default settings for permissions parameter is both.

SecurityBasicAuth or OAuth2
Request
path Parameters
serviceId
required
string

The serviceId to which you want to add the email.

Request Body schema: application/json
email
required
string <email>
required
Array of objects (Number)

Numbers you want to associate with this email.

Responses
201

The added email

Response Schema: application/json
email
required
string <email>
required
Array of objects (Number)

Numbers you want to associate with this email.

projectId
string

The Id of the project associated with the call.

post/services/{serviceId}/emails
Request samples
application/json
{
  • "email": "user@domain.com",
  • "phoneNumbers": [
    • {
      }
    ]
}
Response samples
application/json
{
  • "email": "user@domain.com",
  • "phoneNumbers": [
    • {
      }
    ],
  • "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}

Update numbers for email

Set the numbers for an email.

SecurityBasicAuth or OAuth2
Request
path Parameters
serviceId
required
string

The serviceId containing the email you want to work with.

email
required
string

The email you want to work with.

Request Body schema: application/json
required
Array of objects (Number)

List of numbers

Array
number
string <phoneNumber> (PhoneNumber)

A phone number in E.164 format, including the leading '+'.

permissions
string
Default: "both"

Allows you to set permissions for sending and receiving faxes to this email/phone number combination. Default value is both.

Enum Value Description
both

Allows the email to send and receive faxes to this email/phone number combination.

send

Allows the email to only send faxes to this email/phone number combination.

receive

Allows the email to only receieve faxes from this email/phone number combination.

Responses
200

The added email

Response Schema: application/json
email
required
string <email>
required
Array of objects (Number)

Numbers you want to associate with this email.

projectId
string

The Id of the project associated with the call.

put/services/{serviceId}/emails/{email}
Request samples
application/json
{
  • "phoneNumbers": [
    • {
      }
    ]
}
Response samples
application/json
{
  • "email": "user@domain.com",
  • "phoneNumbers": [
    • {
      }
    ],
  • "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
}

Remove email

Delete an email and associated numbers to that email to disable that email from sending and receiving faxes.

SecurityBasicAuth or OAuth2
Request
path Parameters
serviceId
required
string

The serviceId containing the email you want to work with.

email
required
string

The email you want to work with.

Responses
204

No content: The email was deleted

delete/services/{serviceId}/emails/{email}
Request samples

Get numbers for email

Get configured numbers for an email

SecurityBasicAuth or OAuth2
Request
path Parameters
serviceId
required
string

The serviceId containing the email you want to work with.

email
required
string

The email you want to get numbers for.

query Parameters
pageSize
integer <= 1000
Default: 20

Number of items to return on each page.

Example: pageSize=20
page
string

Optional. The page to fetch. If not specified, the first page will be returned.

Responses
200

A list of numbers associated with the email

Response Schema: application/json
Array of objects (ServicePhoneNumber)

List of numbers

page
integer

Current page

totalPages
integer

Total number of pages.

pageSize
integer

Number of items per page.

totalItems
integer <int32>

Total size of the result.

get/services/{serviceId}/emails/{email}/numbers
Request samples
Response samples
application/json
{
  • "phoneNumbers": [
    • {
      }
    ],
  • "page": 0,
  • "totalPages": 0,
  • "pageSize": 0,
  • "totalItems": 0
}