Използвайте HTTPS и HTTP Basic удостоверяване с одобрени API идентификационни данни. Съхранявайте идентификационните данни на сървъра на приложението си. Тези крайни точки на хостван 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 | Одобрен телефонен номер на подателя (Caller ID). |
| schedule | Планирано време за изпращане, когато се използва. |
| faxquality / pagesize / pagerotate | Поддържани опции за качество, размер на хартията и завъртане. |
| statusemail | Упълномощен адрес за известия за доставка. |
| deleteaftersend | Дали съхраненото качено съдържание да бъде премахнато след изпращането. |
| filename | Препратката към документ, очаквана от този работен процес за факс; не е произволен път до локален файл. |
Проследяване на изпълнението
След изпращането проверете състоянието, опитите и грешката в записа на факса. Потвърдете доставката, вместо да приемате, че приемането означава доставка. Справочникът за факс на портала документира текущия му работен процес за качване и изпращане; пътищата и удостоверяването му са отделни от крайната точка по-горе.