Naudokite HTTPS ir HTTP Basic autentifikavimą su patvirtintais API prisijungimo duomenimis. Prisijungimo duomenis laikykite savo programos serveryje. Šie priglobtos PBX galiniai taškai naudoja /hpbx/ per api.multitel.net; nedėkite /v3. Patikrinkite ir HTTP rezultatą, ir operacijos būseną JSON atsakyme.
Skaityti fakso įrašus
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Pakeiskite atsiskaitymo kodą savo PBX kodu. Grąžinamuose įrašuose nurodomas fakso laikas, kryptis, šaltinis, paskirtis, pristatymo būsena, bandymų skaičius, klaidos ir puslapių skaičius. Priėmus siuntimo užklausą, pristatymas gali dar būti laukiamas.
Siuntimo parametrai
Siuntimo API prieigos taškas yra POST /hpbx/fax/send/{billing_code}. Siuntimas yra tiesioginis veiksmas. Prieš pateikdami paruoškite failą ir šiai paskyrai leidžiamą siuntimo tikslą; nesiųskite pakartotinai aklai, jei siuntimo rezultatas neaiškus.
| Laukas | Reikšmė |
|---|---|
| number | Paskirties fakso numeris. |
| cidnum | Patvirtintas siunčiamas skambintojo ID. |
| schedule | Suplanuotas siuntimo laikas, kai naudojamas. |
| faxquality / pagesize / pagerotate | Palaikomos kokybės, popieriaus dydžio ir pasukimo parinktys. |
| statusemail | Įgaliotas adresas pristatymo pranešimams. |
| deleteaftersend | Ar išsaugotas įkeltas failas turi būti pašalintas po išsiuntimo. |
| filename | Dokumento nuoroda, kurios tikisi ši fakso darbo eiga; tai nėra savavališkas vietinio failo kelias. |
Užbaigimo sekimas
Pateikę patikrinkite fakso įrašo būseną, bandymus ir klaidą. Patvirtinkite pristatymą, o ne laikykite priėmimą pristatymu. Fakso naudojimo portale žinynas aprašo dabartinę įkėlimo ir siuntimo eigą; jos keliai ir autentifikavimas skiriasi nuo aukščiau nurodyto galinio taško.