Faxes

The Fax API allows you to send and receive faxes. You can send faxes to a single recipient or to multiple recipients. You can also receive faxes and download them.

To send a TEST Outbound fax you can send a fax TO +19898989898. This will emulate all aspects of a real fax without charging your account.

OperationsWebhooks

Send a fax

Request

Create and send a fax.

Fax content may be supplied via one or more files or URLs of supported filetypes.

This endpoint supports the following content types for the fax payload:

Multipart/form-data
Application/json

We will however always return a fax object in the response in application json. If you supply a callbackUrl the callback will be sent as multipart/form-data with the content of the fax as an attachment to the body, unless you specify callbackUrlContentType as application/json.

file(s)

Files may be included in the POST request as multipart/form-data parts.

contentUrl

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.

Please note: If you are passing fax a secure URL (starting with https://), make sure that your SSL certificate (including your intermediate cert, if you have one) is installed properly, valid, and up-to-date.

Security

BasicAuth or OAuth2

Body

tostring(phoneNumber)required

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

Example: "+15551235656"

filestring(binary)

The file(s) you want to send as a fax as body attachment.

fromstring(phoneNumber)

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

Example: "+15551235656"

contentUrlstring or Array of strings(URL)write-only

Give us any URL on the Internet (including ones with basic authentication) At least one file or contentUrl parameter is required. Please note: If you are passing fax a secure URL (starting with https://), make sure that your SSL certificate (including your intermediate cert, if you have one) is installed properly, valid, and up-to-date. If the file parameter is specified as well, content from URLs will be rendered before content from files.

You can add multiple URLs by adding them as an array them with a comma when posting as multipart/form-data

For example: "https://developers.sinch.com/fax/fax.pdf, https://developers.sinch.com/" or if posting JSON "contentUrl": ["https://developers.sinch.com/fax/fax.pdf", "https://developers.sinch.com/"]

Example: "https://developers.sinch.com/fax/fax.pdf"

Any of:

Give us any URL on the Internet (including ones with basic authentication) At least one file or contentUrl parameter is required. Please note: If you are passing fax a secure URL (starting with https://), make sure that your SSL certificate (including your intermediate cert, if you have one) is installed properly, valid, and up-to-date. If the file parameter is specified as well, content from URLs will be rendered before content from files.

You can add multiple URLs by adding them as an array them with a comma when posting as multipart/form-data

For example: "https://developers.sinch.com/fax/fax.pdf, https://developers.sinch.com/" or if posting JSON "contentUrl": ["https://developers.sinch.com/fax/fax.pdf", "https://developers.sinch.com/"]

string(URL)write-only

headerTextstring<= 50

Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is "-". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails.

Default ""

headerPageNumbersboolean

If true, page numbers will be displayed in the header. Default is true.

Default true

headerTimeZonestring(timezone)

A TZ database name string specifying the timezone for the header timestamp.

Default "America/New_York"

retryDelaySecondsinteger[ 30 .. 300 ]

The number of seconds to wait between retries if the fax is not yet completed.

Default 60

labelsobject(label)

You can use this to attach labels to your call that you can use in your applications. It is a key value store.

application/json format: "labels": {"label1":"value1"}
multipart/form-data format: labels[label1] = value1

Example: {"use-case":"fraudPrevention","costCenter":"sales"}

callbackUrlstring(URL)

The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the callbackUrl parameter, if provided, otherwise it will be sent to the URL specified in the callbackUrl field of the Fax Service object.

Example: "https://www.my-website.com/callback"

callbackUrlContentTypestring

The content type of the callback.

Default "multipart/form-data"

Enum Value	Description
multipart/form-data	The callback will be sent as a multipart/form-data request with files as attachments to the body.
application/json	The callback will be sent as a JSON request with the files as base64 encoded strings in the JSON object.

imageConversionMethodstring(ImageConversionMethod)

Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.

Enum Value	Description
HALFTONE	Converts the image to halftone.
MONOCHROME	Converts the image to monochrome.

maxRetriesinteger[ 0 .. 5 ]

| The number of times the fax will be retired before cancel. Default value is set in your fax service. | The maximum number of retries is 5.

resolutionstring(Resolution)

The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.

Enum Value	Description
FINE	Most commonly accepted fax resolution at 200 dpi.
SUPERFINE	Higher but less commonly accepted fax resolution at 400 dpi. May be required when sending small text or detailed images.

coverPageIdstring

The cover page id you want to use for the fax

coverPageDataobject(CoverPageData)

You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this here. All keys used must be lower case.

application/json format: "coverPageData": {"customfield1":"customdata1"}
multipart/form-data format: coverPageData[customfield1] = customdata1

inProgressNotificationsboolean

If set to true, you will receive a webhook notification for each page sent on an outbound fax.

Default false

serviceIdstring

ID of the fax service used.

Example: "01GVRB50KEQFFE1SGMPFRNBG6J"

curl -i -X POST \
  -u <username>:<password> \
  https://fax.api.sinch.com/v3/projects/YOUR_project_id/faxes \
  -H 'Content-Type: multipart/form-data' \
  -F 'to=+14155552222' \
  -F contentUrl=https://developers.sinch.com/fax/fax.pdf

Responses

The created fax

Bodyapplication/json

idstringread-only

The id of a fax

Example: "01F3J0G1M4WQR6HGY6HCF6JA0K"

directionstringread-only

The direction of the fax.

Enum Value	Description
OUTBOUND	The fax was sent by you via the API.
INBOUND	The fax was received on one of your numbers.

Example: "OUTBOUND"

fromstring(phoneNumber)

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

Example: "+15551235656"

tostring(phoneNumber)

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

Example: "+15551235656"

numberOfPagesintegerread-only

The number of pages in the fax.

statusstring(FaxStatus)read-only

The status of the fax

Enum Value	Description
QUEUED	The operation is currently in a queue on a server and should be executed very soon.
IN_PROGRESS	The fax is currently being sent (OUTBOUND) or received (INBOUND).
COMPLETED	The fax operation succeeded. Everything went as normally planned.
FAILURE	The fax operation failed. Details of the error can be found in the error_code field. For OUTBOUND fax, this means that NONE of the recipients received the fax.

priceobjectread-only

This is where we need description to be overridden by $ref: description

barCodesArray of objects(BarCode)read-only

The bar codes found in the fax. This field is populated when Sinch detects bar codes on incoming faxes.

createTimestring(date-time)read-only

A timestamp representing the time when the initial API call was made.

completedTimestring(date-time)read-only

If the job is complete, this is a timestamp representing the time the job was completed.

pagesSentSuccessfullyintegerread-only

The number of pages successfully sent to the receiving side in the fax.

Example: 3

headerTextstring<= 50

Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is "-". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails.

Default ""

headerPageNumbersboolean

If true, page numbers will be displayed in the header. Default is true.

Default true

headerTimeZonestring(timezone)

A TZ database name string specifying the timezone for the header timestamp.

Default "America/New_York"

retryDelaySecondsinteger[ 30 .. 300 ]

The number of seconds to wait between retries if the fax is not yet completed.

Default 60

labelsobject(label)

You can use this to attach labels to your call that you can use in your applications. It is a key value store.

application/json format: "labels": {"label1":"value1"}
multipart/form-data format: labels[label1] = value1

Example: {"use-case":"fraudPrevention","costCenter":"sales"}

callbackUrlstring(URL)

The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the callbackUrl parameter, if provided, otherwise it will be sent to the URL specified in the callbackUrl field of the Fax Service object.

Example: "https://www.my-website.com/callback"

callbackUrlContentTypestring

The content type of the callback.

Default "multipart/form-data"

Enum Value	Description
multipart/form-data	The callback will be sent as a multipart/form-data request with files as attachments to the body.
application/json	The callback will be sent as a JSON request with the files as base64 encoded strings in the JSON object.

imageConversionMethodstring(ImageConversionMethod)

Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.

Enum Value	Description
HALFTONE	Converts the image to halftone.
MONOCHROME	Converts the image to monochrome.

errorTypestringread-only

Error type

Enum Value	Description
DOCUMENT_CONVERSION_ERROR	A documentation conversion error.
CALL_ERROR	A call error.
FAX_ERROR	A fax error.
FATAL_ERROR	A fatal error.
GENERAL_ERROR	A general error.

errorCodeintegerread-only

One of the error numbers listed in the Fax Error Messages section.

errorMessagestringread-only

One of the error codes listed in the Fax Error Messages section.

maxRetriesinteger[ 0 .. 5 ]

| The number of times the fax will be retired before cancel. Default value is set in your fax service. | The maximum number of retries is 5.

retryCountintegerread-only

The number of times the fax has been retried.

hasFilestringread-only

Only shown on the fax result. This indicates if the content of the fax is stored with Sinch. (true or false)

resolutionstring(Resolution)

The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.

Enum Value	Description
FINE	Most commonly accepted fax resolution at 200 dpi.
SUPERFINE	Higher but less commonly accepted fax resolution at 400 dpi. May be required when sending small text or detailed images.

coverPageIdstring

The cover page id you want to use for the fax

coverPageDataobject(CoverPageData)

You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this here. All keys used must be lower case.

application/json format: "coverPageData": {"customfield1":"customdata1"}
multipart/form-data format: coverPageData[customfield1] = customdata1

inProgressNotificationsboolean

If set to true, you will receive a webhook notification for each page sent on an outbound fax.

Default false

projectIdstringread-only

The Id of the project associated with the call.

Example: "ae00f005-e392-44dc-b3f5-a657a2684dg3"

serviceIdstring

ID of the fax service used.

Example: "01GVRB50KEQFFE1SGMPFRNBG6J"

Response

application/json

{
  "id": "01HDF5S9P29WC29J578J8EKC1C",
  "direction": "OUTBOUND",
  "to": "+1234567890",
  "status": "IN_PROGRESS",
  "headerTimeZone": "America/New_York",
  "retryDelaySeconds": 60,
  "callbackUrl": "https://my.callback.server",
  "projectId": "YOUR_PROJECT_ID",
  "serviceId": "YOUR_SERVICE_ID",
  "maxRetries": 3,
  "createTime": "2023-10-23T21:06:52.231Z",
  "headerPageNumbers": true,
  "contentUrl": [
    "www.google.com"
  ],
  "imageConversionMethod": "HALFTONE"
}

List faxes

Request

List faxes sent (OUTBOUND) or received (INBOUND), set parameters to filter the list. Example: Return calls made between 1st of January 2021 and 10th of January 2021.

 created>=2021-01-01&startTime<=2021-01-10

Security

BasicAuth or OAuth2

Query

serviceIdstring

Limits results to faxes that were sent using the specified service.

Example: serviceId=YOUR_SERVICE_ID

createTimestring(date-time)

Filter calls based on createTime. If you make the query more precise, fewer results will be returned. For example, 2021-02-01 will return all calls from the first of February 2021, and 2021-02-01T14:00:00Z will return all calls after 14:00 on the first of February. This field also supports <= and >= to search for calls in a range ?createTime>=2021-10-01&startTime<=2021-10-30 to get a list of calls for all of October 2021. It is also possible to submit partial dates. For example, createTime=2021-02 will return all calls for February 2021.

If not value is submitted, the default value is the prior week.

directionstring(FaxDirection)read-only

Limits results to faxes with the specified direction.

Enum Value	Description
OUTBOUND	The fax was sent by you via the API.
INBOUND	The fax was received on one of your numbers.

Example: direction=OUTBOUND

statusstring(FaxStatus)read-only

Limits results to faxes with the specified status.

Enum Value	Description
QUEUED	The operation is currently in a queue on a server and should be executed very soon.
IN_PROGRESS	The fax is currently being sent (OUTBOUND) or received (INBOUND).
COMPLETED	The fax operation succeeded. Everything went as normally planned.
FAILURE	The fax operation failed. Details of the error can be found in the error_code field. For OUTBOUND fax, this means that NONE of the recipients received the fax.

Example: status=COMPLETED

tostring(phoneNumber)(PhoneNumber)

A phone number that you want to use to filter results. The parameter search with startsWith, so you can pass a partial number to get all faxes sent to numbers that start with the number you passed.

Example: to=+14155552222

fromstring(phoneNumber)(PhoneNumber)

A phone number that you want to use to filter results. The parameter search with startsWith, so you can pass a partial number to get all faxes sent to numbers that start with the number you passed.

Example: from=+15551235656

pageSizeinteger[ 1 .. 1000 ]

The maximum number of items to return per request. The default is 100 and the maximum is 1000. If you need to export larger amounts and pagination is not suitable for you can use the Export function in the dashboard.

pagestring

The page you want to retrieve returned from a previous List request, if any

curl -i -X GET \
  -u <username>:<password> \
  'https://fax.api.sinch.com/v3/projects/YOUR_project_id/faxes?serviceId=YOUR_SERVICE_ID&createTime=2019-08-24T14%3A15%3A22Z&direction=OUTBOUND&status=COMPLETED&to=%2B14155552222&from=%2B15551235656&pageSize=1&page=string'

Responses

Result of the query.

Bodyapplication/json

faxesArray of objects(Fax)

An array of faxes

pageintegerread-only

Current page

totalPagesintegerread-only

Total number of pages.

pageSizeintegerread-only

Number of items per page.

totalItemsinteger(int32)read-only

Total size of the result.

Response

application/json

{
  "faxes": [
    { … }
  ],
  "page": 0,
  "totalPages": 0,
  "pageSize": 0,
  "totalItems": 0
}

Get fax

Request

Get fax information using the ID number of the fax.

Security

BasicAuth or OAuth2

Path

idstring(FaxId)read-onlyrequired

The ID of the fax.

Example: 01F3J0G1M4WQR6HGY6HCF6JA0K

curl -i -X GET \
  -u <username>:<password> \
  https://fax.api.sinch.com/v3/projects/YOUR_project_id/faxes/01F3J0G1M4WQR6HGY6HCF6JA0K

Responses

The fax

Bodyapplication/json

idstringread-only

The id of a fax

Example: "01F3J0G1M4WQR6HGY6HCF6JA0K"

directionstringread-only

The direction of the fax.

Enum Value	Description
OUTBOUND	The fax was sent by you via the API.
INBOUND	The fax was received on one of your numbers.

Example: "OUTBOUND"

fromstring(phoneNumber)

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

Example: "+15551235656"

tostring(phoneNumber)

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

Example: "+15551235656"

numberOfPagesintegerread-only

The number of pages in the fax.

statusstring(FaxStatus)read-only

The status of the fax

Enum Value	Description
QUEUED	The operation is currently in a queue on a server and should be executed very soon.
IN_PROGRESS	The fax is currently being sent (OUTBOUND) or received (INBOUND).
COMPLETED	The fax operation succeeded. Everything went as normally planned.
FAILURE	The fax operation failed. Details of the error can be found in the error_code field. For OUTBOUND fax, this means that NONE of the recipients received the fax.

priceobjectread-only

This is where we need description to be overridden by $ref: description

barCodesArray of objects(BarCode)read-only

The bar codes found in the fax. This field is populated when Sinch detects bar codes on incoming faxes.

createTimestring(date-time)read-only

A timestamp representing the time when the initial API call was made.

completedTimestring(date-time)read-only

If the job is complete, this is a timestamp representing the time the job was completed.

pagesSentSuccessfullyintegerread-only

The number of pages successfully sent to the receiving side in the fax.

Example: 3

headerTextstring<= 50

Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is "-". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails.

Default ""

headerPageNumbersboolean

If true, page numbers will be displayed in the header. Default is true.

Default true

headerTimeZonestring(timezone)

A TZ database name string specifying the timezone for the header timestamp.

Default "America/New_York"

retryDelaySecondsinteger[ 30 .. 300 ]

The number of seconds to wait between retries if the fax is not yet completed.

Default 60

labelsobject(label)

You can use this to attach labels to your call that you can use in your applications. It is a key value store.

application/json format: "labels": {"label1":"value1"}
multipart/form-data format: labels[label1] = value1

Example: {"use-case":"fraudPrevention","costCenter":"sales"}

callbackUrlstring(URL)

The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the callbackUrl parameter, if provided, otherwise it will be sent to the URL specified in the callbackUrl field of the Fax Service object.

Example: "https://www.my-website.com/callback"

callbackUrlContentTypestring

The content type of the callback.

Default "multipart/form-data"

Enum Value	Description
multipart/form-data	The callback will be sent as a multipart/form-data request with files as attachments to the body.
application/json	The callback will be sent as a JSON request with the files as base64 encoded strings in the JSON object.

imageConversionMethodstring(ImageConversionMethod)

Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.

Enum Value	Description
HALFTONE	Converts the image to halftone.
MONOCHROME	Converts the image to monochrome.

errorTypestringread-only

Error type

Enum Value	Description
DOCUMENT_CONVERSION_ERROR	A documentation conversion error.
CALL_ERROR	A call error.
FAX_ERROR	A fax error.
FATAL_ERROR	A fatal error.
GENERAL_ERROR	A general error.

errorCodeintegerread-only

One of the error numbers listed in the Fax Error Messages section.

errorMessagestringread-only

One of the error codes listed in the Fax Error Messages section.

maxRetriesinteger[ 0 .. 5 ]

| The number of times the fax will be retired before cancel. Default value is set in your fax service. | The maximum number of retries is 5.

retryCountintegerread-only

The number of times the fax has been retried.

hasFilestringread-only

Only shown on the fax result. This indicates if the content of the fax is stored with Sinch. (true or false)

resolutionstring(Resolution)

The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.

Enum Value	Description
FINE	Most commonly accepted fax resolution at 200 dpi.
SUPERFINE	Higher but less commonly accepted fax resolution at 400 dpi. May be required when sending small text or detailed images.

coverPageIdstring

The cover page id you want to use for the fax

coverPageDataobject(CoverPageData)

You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this here. All keys used must be lower case.

application/json format: "coverPageData": {"customfield1":"customdata1"}
multipart/form-data format: coverPageData[customfield1] = customdata1

inProgressNotificationsboolean

If set to true, you will receive a webhook notification for each page sent on an outbound fax.

Default false

projectIdstringread-only

The Id of the project associated with the call.

Example: "ae00f005-e392-44dc-b3f5-a657a2684dg3"

serviceIdstring

ID of the fax service used.

Example: "01GVRB50KEQFFE1SGMPFRNBG6J"

Response

application/json

{
  "id": "01HDF5S9P29WC29J578J8EKC1C",
  "direction": "OUTBOUND",
  "to": "+1234567890",
  "status": "IN_PROGRESS",
  "headerTimeZone": "America/New_York",
  "retryDelaySeconds": 60,
  "callbackUrl": "https://my.callback.server",
  "projectId": "YOUR_PROJECT_ID",
  "serviceId": "YOUR_SERVICE_ID",
  "maxRetries": 3,
  "createTime": "2023-10-23T21:06:52.231Z",
  "headerPageNumbers": true,
  "contentUrl": [
    "www.google.com"
  ],
  "imageConversionMethod": "HALFTONE",
  "hasFile": false
}

Delete fax content

Request

Delete the fax content for a fax using the ID number of the fax. Please note that this only deletes the content of the fax from storage.

Security

BasicAuth or OAuth2

Path

idstring(FaxId)read-onlyrequired

The ID of the fax.

Example: 01F3J0G1M4WQR6HGY6HCF6JA0K

curl -i -X DELETE \
  -u <username>:<password> \
  https://fax.api.sinch.com/v3/projects/YOUR_project_id/faxes/01F3J0G1M4WQR6HGY6HCF6JA0K/file

Responses

The fax content was deleted.

Download fax content

Request

Download the fax content.

Security

BasicAuth or OAuth2

Path

idstring(FaxId)read-onlyrequired

The ID of the fax.

Example: 01F3J0G1M4WQR6HGY6HCF6JA0K

fileFormatstringrequired

The file format to download. Currently only PDF is supported.

Default "pdf"

Value	Description
pdf	PDF format

Example: pdf

curl -i -X GET \
  -u <username>:<password> \
  https://fax.api.sinch.com/v3/projects/YOUR_project_id/faxes/01F3J0G1M4WQR6HGY6HCF6JA0K/file.pdf

Responses

A file for the fax you requested will be returned in the format you specified.

Bodyapplication/pdf

string(binary)

A PDF file named 'fax-1234.pdf' containing all files sent for fax #1234.

Incoming fax eventWebhook

Request

This webhook is triggered when a fax is received on a Sinch number associated with a service. The webhook will contain information about the fax, such as the sender, the recipient, and the content of the fax. You set the callback URL for incoming fax events on the service, either through the dashboard or using the service API.

Example payloads

Multipart/form-data request payloads are encoded as forms with a content type of JSON and the actual fax content as a 'file' application/pdf attachment.

Application/json request payloads are a JSON object with the file encoded as a base64 string as part of the JSON object.

Security

BasicAuth

Body

eventstring

The value is always INCOMING_FAX for this event.

Default "INCOMING_FAX"

Enum Value	Description
INCOMING_FAX	A webhook event triggered by an fax is incoming.
FAX_COMPLETED	A webhook event triggered by a fax that has successfully completed.

filestring(binary)binary

The fax content as a PDF attachment to the body

eventTimestring(date-time)

Time of the event.

faxobject(Fax)

{
  "event": "INCOMING_FAX",
  "eventTime": "2021-11-01T23:25:67Z",
  "fax": {
    "id": "01HDFHACK1YN7CCDYRA6ZRMA8Z",
    "direction": "INBOUND",
    "from": "+14155552222",
    "to": "+14155553333",
    "numberOfPages": 1,
    "status": "COMPLETED",
    "price": {
      "amount": "0.00",
      "currencyCode": "USD"
    },
    "createTime": "2021-11-01T23:25:67Z",
    "completedTime": "2021-11-01T23:25:67Z",
    "projectId": "YOUR_PROJECT_ID",
    "serviceId": "YOUR_SERVICE_ID"
  },
  "file": "{application/pdf}"
}

Responses

Returns a 200 OK response if the webhook was received successfully.

Fax completedWebhook

Request

Triggered when the fax has been completed. The callback will contain information about the fax, such as the sender, the recipient, and the content of the fax. You must set the callback URL where you want the callback sent when you make a send fax request.

Security

BasicAuth

Body

eventstring

Always fax completed for this event.

Default "FAX_COMPLETED"

Enum Value	Description
INCOMING_FAX	A webhook event triggered by an fax is incoming.
FAX_COMPLETED	A webhook event triggered by a fax that has successfully completed.

filestring(binary)binary

The fax content as pdf attachment to the body

eventTimestring(date-time)

Time of the event.

faxobject(Fax)

{
  "event": "FAX_COMPLETED",
  "eventTime": "2021-11-01T23:25:67Z",
  "fax": {
    "id": "01HDFHACK1YN7CCDYRA6ZRMA8Z",
    "direction": "INBOUND",
    "from": "+14155552222",
    "to": "+14155553333",
    "numberOfPages": 1,
    "status": "COMPLETED",
    "price": {
      "amount": "0.07",
      "currencyCode": "USD"
    },
    "createTime": "2021-11-01T23:25:67Z",
    "completedTime": "2021-11-01T23:25:67Z",
    "callbackUrl": "https://www.my-website.com/callback",
    "callbackUrlContentType": "multipart/form-data",
    "imageConversionMethod": "HALFTONE",
    "projectId": "YOUR_PROJECT_ID",
    "serviceId": "YOUR_SERVICE_ID"
  },
  "file": "{application/pdf}"
}

Responses

Returns a 200 OK response if the webhook was received successfully.

Notifications

Webhooks allow you to get updates in real-time about the status of your faxes. Webhooks are triggered by events such as the completion of a fax, and transmit information about the state of that fax to you via HTTP(S) or email. HTTP webhooks are multipart/form-data POST requests, and should be processed like form submissions.

Webhooks

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.

Operations

Cover pages

You can add cover pages to Sinch Fax either via the API or the Build dashboard.

A Fax service can have 0 or more cover pages configured.

Operations

Error Messages

Services

A fax service identifies a set of configuration values. You can specify the service as a part of an API request or by associating a Sinch number with a service.

This can be useful if you want to point a group of numbers to a particular incoming fax URL, or want to set the storage strategy for some of your numbers but not all of them.

Operations

Fax API (3.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Authentication

Global URL

Formats

Date time fields

Deletion and data retention

Errors & statuses

Webhooks

Faxes

Send a fax

RequestExpand all

file(s)

contentUrl

Responses

Was this helpful?

List faxes

Request

Responses

Was this helpful?

Get fax

Request

Responses

Was this helpful?

Delete fax content

Request

Responses

Was this helpful?

Download fax content

Request

Responses

Was this helpful?

Incoming fax eventWebhook

RequestExpand all

Example payloads

Responses

Was this helpful?

Fax completedWebhook

RequestExpand all

Responses

Was this helpful?

Notifications

Fax to Email

Cover pages

Error Messages

Services

Fax API (3.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request

Request

Request