Koristite HTTPS i HTTP Basic autentifikaciju s odobrenim API vjerodajnicama. Vjerodajnice čuvajte na svom aplikacijskom poslužitelju. Ove krajnje točke hostiranog PBX-a koriste /hpbx/ na api.multitel.net; nemojte umetati /v3. Provjerite i HTTP rezultat i status operacije u JSON odgovoru.
Čitanje zapisa faksa
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Zamijenite obračunski kod (billing code) kodom svojeg PBX-a. Vraćeni zapisi uključuju vrijeme faksa, smjer, izvor, odredište, status isporuke, pokušaje, pogreške i broj stranica. Isporuka može i dalje biti na čekanju kad je zahtjev za slanje prihvaćen.
Parametri slanja
Krajnja točka za slanje je POST /hpbx/fax/send/{billing_code}. Slanje je stvarna radnja. Pripremite datoteku i odredište ovlašteno za račun prije slanja; ne ponavljajte slijepo slanje čiji je ishod neizvjestan.
| Polje | Značenje |
|---|---|
| number | Odredišni broj faksa. |
| cidnum | Odobreni identifikator pozivatelja za slanje. |
| schedule | Planirano vrijeme slanja, kada se koristi. |
| faxquality / pagesize / pagerotate | Podržane mogućnosti kvalitete, veličine papira i rotacije. |
| statusemail | Ovlaštena adresa za obavijesti o isporuci. |
| deleteaftersend | Određuje treba li pohranjenu učitanu datoteku ukloniti nakon slanja. |
| filename | Referenca dokumenta koju očekuje ovaj tijek rada faksa; nije proizvoljna putanja lokalne datoteke. |
Praćenje dovršetka
Nakon slanja provjerite status zapisa faksa, pokušaje i pogrešku. Potvrdite isporuku umjesto da prihvaćanje tumačite kao isporuku. Dokumentacija za faks na portalu dokumentira njegov trenutni tijek učitavanja i slanja; njegove staze i provjera autentičnosti odvojene su od gore navedene krajnje točke.