Как отправить факс с с помощью API?

Обновлено 04/10/2023 10:50

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

Доступно наEnterprise плане.

Все члены.

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

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

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

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

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

Не забудьте включить в ваш запрос следующие заголовки:

Тип контента:

мультичастные/форм-данные

Авторизация:

Носитель [маркер доступа]

- x-fax-clientid:
```
[ID клиента]
```

Для кузова:

{
"fax_file": [file]
}

‍

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

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

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

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

Шаг 2: Отправить факс с с помощью API

Once the uploads are completed, you can begin preparing your fax for sending. Для начала процесса выполните запрос POST HTTP на следующий URL:
https://restapi.fax. lus/v3/accounts/[ID пользователя]/outbox

Не забудьте включить в ваш запрос следующие заголовки:

Авторизация:

Носитель [маркер доступа]

x-fax-clientid:
```
[ID клиента]
```

а) в отношении органа, обратившегося с запросом:

{
"от": "",
"до": [
""
],
"файлы": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

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

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

Note: Факсы ассоциируются с несколькими идентификаторами нашего API. Данный дизайн существует, так как передача факса работает асинхронно. В частности, исходящий факс будет определен двумя отдельными идентификаторами: идентификатор исходящего сообщения, который служит его цели до тех пор, пока не будет успешно отправлен факс, и идентификатор факса, который становится окончательным идентификатором для факса после его успешной передачи.

Шаг 3: Используйте вебхуки для проверки статуса отправленного факса

After scheduling the fax, you can monitor its status by reviewing the list of faxes located in the outbox or the sent category.

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

Выполните следующие шаги для настройки Webhook:

Войдите в свою учетную запись Fax.Plus и перейдите в раздел Profileна вашей панели управления.
Под вкладкой Integrationsнайдите поле для Web Hooks.
Найти входящие факсы и входящие факсы. Нажмите Manage для изменения Webhook.

После настройки Webhook вы получите следующее уведомление после обработки факса:

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

Это сообщение предоставит вам время передачи, укажите успех передачи факса (через поле "статус"), и предоставьте Вам уникальный идентификатор факса. This fax ID can be utilized to retrieve the fax file or obtain a fax confirmation report.

Need Support?