Hosted PBX API: записи факсов и отправка

Используйте HTTPS и аутентификацию HTTP Basic с одобренными учетными данными API. Храните учетные данные на сервере приложений. Эти конечные точки Hosted PBX используют /hpbx/ на api.multitel.net; не вставляйте /v3. Проверяйте как результат HTTP, так и статус приложения в ответе JSON.

Чтение записей факсов

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

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

Параметры отправки

Конечная точка отправки: POST /hpbx/fax/send/{billing_code}. Отправка — это реальное действие. Подготовьте файл и назначение, разрешённое для вашей учётной записи, прежде чем отправлять; не повторяйте вслепую отправку, результат которой неясен.

ПолеЗначение
numberНомер факса назначения.
cidnumУтверждённый идентификатор вызывающего абонента отправителя.
scheduleЗапланированное время отправки, если используется.
faxquality / pagesize / pagerotateПоддерживаемые параметры качества, размера бумаги и поворота.
statusemailАвторизованный адрес для уведомлений о доставке.
deleteaftersendНужно ли удалить сохранённый загруженный файл после отправки.
filenameСсылка на документ, ожидаемая этим процессом работы с факсами; это не произвольный путь к локальному файлу.

Отслеживание завершения

После отправки проверьте статус, попытки и ошибку в записи факса. Подтвердите доставку, а не считайте принятие факса доставкой. В документе справочник по факсу на портале описан текущий порядок загрузки и отправки; его пути и аутентификация отличаются от указанной выше конечной точки.

Поиск документации