Používejte HTTPS a ověřování HTTP Basic se schválenými přihlašovacími údaji API. Uchovávejte přihlašovací údaje na svém aplikačním serveru. Tyto koncové body Hosted PBX používají /hpbx/ na api.multitel.net; nevkládejte /v3. Zkontrolujte výsledek HTTP i stav operace v odpovědi JSON.
Čtení záznamů o faxech
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Nahraďte ukázkový fakturační kód kódem své ústředny PBX. Vrácené záznamy zahrnují čas faxu, směr, zdroj, cíl, stav doručení, pokusy, chyby a počet stránek. Doručení může být stále nevyřízené, i když je požadavek na odeslání přijat.
Parametry odesílání
Koncový bod pro odeslání je POST /hpbx/fax/send/{billing_code}. Odeslání provede skutečnou akci. Před odesláním připravte soubor a cílové číslo, pro které má účet oprávnění. Pokud si nejste jisti výsledkem odeslání, neopakujte jej naslepo.
| Pole | Význam |
|---|---|
| number | Cílové faxové číslo. |
| cidnum | Schválené ID volajícího pro odesílání. |
| schedule | Naplánovaný čas odeslání, je-li použit. |
| faxquality / pagesize / pagerotate | Podporované možnosti kvality, velikosti papíru a otočení. |
| statusemail | Autorizovaná adresa pro oznámení o doručení. |
| deleteaftersend | Zda se má uložený nahraný soubor po odeslání odstranit. |
| filename | Odkaz na dokument, který tento faxový postup očekává; nejde o libovolnou cestu k místnímu souboru. |
Sledování dokončení
Po odeslání zkontrolujte stav záznamu faxu, počet pokusů a chybu. Doručení potvrďte; přijetí nepovažujte za doručení. Dokumentace faxu v portálu dokumentuje jeho aktuální postup nahrávání a odesílání; jeho cesty a ověřování jsou oddělené od výše uvedeného koncového bodu.