Használjon HTTPS-t és HTTP Basic hitelesítést jóváhagyott API-hitelesítő adatokkal. A hitelesítő adatokat tartsa az alkalmazásszerverén. Ezek a hosztolt PBX-végpontok a(z) api.multitel.net címen a(z) /hpbx/ elérési utat használják; ne illesszen be /v3 elemet. Ellenőrizze mind a HTTP-eredményt, mind a JSON-válaszban szereplő alkalmazásszintű állapotot.
Faxnaplók olvasása
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Cserélje ki a példabeli számlázási kódot saját PBX-e kódjára. A visszaadott rekordok tartalmazzák a fax idejét, irányát, forrását, célját, kézbesítési állapotát, a próbálkozásokat, hibákat és az oldalszámot. A kézbesítés még függőben lehet, amikor egy küldési kérés elfogadásra kerül.
Küldési paraméterek
A küldési végpont: POST /hpbx/fax/send/{billing_code}. A küldés éles művelet. A beküldés előtt készítse elő a fájlt és a fiókjához engedélyezett célt; ne ismételje meg vakon a bizonytalan küldést.
| Mező | Jelentés |
|---|---|
| number | Cél faxszám. |
| cidnum | Jóváhagyott küldő telefonszáma (hívóazonosító). |
| schedule | Ütemezett küldési idő, használat esetén. |
| faxquality / pagesize / pagerotate | Támogatott minőségi, papírméret- és elforgatási beállítások. |
| statusemail | Kézbesítési értesítések fogadására jogosult cím. |
| deleteaftersend | Meghatározza, hogy küldés után törölni kell-e a tárolt, feltöltött fájlt. |
| filename | Az ehhez a faxfolyamathoz várt dokumentumhivatkozás; nem tetszőleges helyi fájlelérési út. |
Befejezés nyomon követése
A beküldés után ellenőrizze a faxrekord állapotát, a próbálkozások számát és a hibát. Győződjön meg a kézbesítésről; ne tekintse a kézbesítéssel egyenértékűnek az elfogadást. A portál faxreferenciája a jelenlegi feltöltési és küldési munkafolyamatot dokumentálja; az elérési útjai és a hitelesítése különállnak a fenti végpontétól.