Как отправить fax через API?

Обновлено 11/09/2026 17:11

Кто может использовать эту функцию?

Доступно на тарифе Enterprise plan.

Для всех участников.

Чтобы отправить fax через API, сначала загрузите нужные файлы, затем подготовьте их для отправки и запланируйте передачу.

После того как fax запланирован, вы можете реализовать HTTP-сервер и использовать механизм webhook. Такой подход гарантирует отправку HTTP-сообщения как при успешной передаче fax, так и в случае сбоя передачи.

Примечание: убедитесь, что вы завершили процесс первоначальной аутентификации и успешно вошли в API. Дополнительные инструкции приведены в нашем руководстве здесь.

Шаг 1: Загрузка файлов для отправки по факсу

Чтобы загрузить файл, отправьте HTTP-запрос POST на следующий URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']

Убедитесь, что в запросе указаны следующие заголовки:

- Content-Type:
```
multipart/form-data
```

- Authorization:
```
Bearer [access token]
```

- x-fax-clientid:
```
[client ID]
```

Для тела запроса:

{
  "fax_file": [file]
}

‍

В следующем примере в качестве идентификатора пользователя используется значение «self», обозначающее уникальный идентификатор текущего авторизованного пользователя:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

После успешной загрузки файла вы получите путь к его временному расположению на Fax.Plus.

Шаг 2: Отправка факса через API

После завершения загрузки можно приступить к подготовке факса к отправке. Чтобы начать процесс, выполните HTTP-запрос POST на следующий URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

Убедитесь, что в запросе указаны следующие заголовки:

- Authorization:
```
Bearer [access token]
```
- x-fax-clientid:
```
[client ID]
```

Для тела запроса:

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

После успешного планирования факса вы получите Outbox ID. Этот идентификатор можно использовать для изменения или удаления факса до его фактической отправки.

Примечание: в нашем API с факсом связано несколько идентификаторов. Это связано с тем, что передача факса происходит асинхронно. А именно, исходящий факс обозначается двумя разными идентификаторами: Outbox ID, который действует до момента успешной отправки факса, и Fax ID, который становится окончательным идентификатором факса после его успешной передачи.

Шаг 3: Проверка статуса отправленного факса с помощью веб-хуков

После планирования факса вы можете отслеживать его статус, просматривая список факсов в разделе исходящих или отправленных.

Кроме того, вы можете настроить собственный HTTP-сервер и использовать веб-хук. В этом случае при успешной отправке факса или при сбое отправки будет отправлено HTTP-сообщение.

Чтобы настроить веб-хук, выполните следующие шаги:

Войдите в свою учётную запись Fax.Plus и перейдите в раздел Настройки на панели управления.
На вкладке Integrations найдите блок WebHooks.
Найдите пункты, относящиеся к уведомлениям об исходящих факсах, и нажмите Manage, чтобы изменить настройки веб-хука.

После настройки веб-хука вы будете получать следующее уведомление при каждой обработке исходящего факса:

{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}

Это сообщение содержит время передачи, указывает на успешность передачи факса (в поле «status») и предоставляет уникальный идентификатор факса. Этот идентификатор факса можно использовать, чтобы получить файл факса или получить отчёт о подтверждении факса.

Need Support?