- Incoming fax event
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.
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.
The value is always INCOMING_FAX for this event.
| 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. |
When request/response is multipart/form-data and file is part of payload. This is the file type of the file.
| Enum Value | Description |
|---|---|
| application/docx | Microsoft Word |
| application/pdf | |
| application/tif | TIFF |
| application/jpg | JPEG |
| application/txt | Text |
| application/html | HTML |
| application/png | PNG |
- v3.0 of the Fax APIhttps://fax.api.sinch.com/incomingFax
{
"event": "INCOMING_FAX",
"eventTime": "2021-11-01T23:25:57Z",
"fax": {
"id": "01HDFHACK1YN7CCDYRA6ZRMA8Z",
"direction": "INBOUND",
"from": "+14155552222",
"to": "+14155553333",
"numberOfPages": 1,
"status": "COMPLETED",
"price": {
"amount": "0.00",
"currencyCode": "USD"
},
"createTime": "2021-11-01T23:25:57Z",
"completedTime": "2021-11-01T23:25:57Z",
"projectId": "YOUR_PROJECT_ID",
"serviceId": "YOUR_SERVICE_ID"
},
"file": "{application/pdf}"
}
