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

Обновлено 17/10/2026 05:30

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

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

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

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

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

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

Шаг 1: загрузите файлы для отправки fax

Чтобы загрузить файл, отправьте 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]
}

‍

В следующем примере в качестве ID пользователя используется значение "self". Оно обозначает уникальный идентификатор пользователя, который выполнил вход:

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

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

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

Шаг 2: отправьте fax через API

После завершения загрузки можно подготовить fax к отправке. Для этого отправьте 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

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

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

Шаг 3: проверяйте статус отправленного fax с помощью webhook

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

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

Чтобы настроить webhook, выполните следующие действия:

Войдите в аккаунт Fax.Plus и откройте раздел Настройки на панели управления.
На вкладке Интеграции найдите блок WebHooks.
Найдите Входящие fax и Входящие fax. Нажмите Управление, чтобы изменить webhook.

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

{
"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"
}
}

Сообщение содержит время передачи, сведения об успешности передачи fax (поле "status") и уникальный Fax ID. С помощью этого Fax ID можно получить файл fax или запросить отчёт о подтверждении отправки fax.

Нужна поддержка?