Kasutage HTTPS-i ja HTTP Basic autentimist kinnitatud API juurdepääsuandmetega. Hoidke juurdepääsuandmeid oma rakendusserveris. Need Hosted PBX lõpp-punktid kasutavad /hpbx/ asukohas api.multitel.net; ärge lisage /v3. Kontrollige nii HTTP tulemust kui ka toimingu olekut JSON-vastuses.
Faksikirjete lugemine
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Asendage näite arvelduskood oma PBX-i koodiga. Tagastatud kirjed sisaldavad faksi aega, suunda, allikat, sihtkohta, edastuse olekut, katseid, vigu ja lehekülgede arvu. Edastus võib saatmistaotluse vastuvõtmisel olla veel ootel.
Saatmisparameetrid
Saatmise lõpp-punkt on POST /hpbx/fax/send/{billing_code}. See toiming saadab faili päriselt. Enne saatmist valmistage ette fail ja sihtkoht, kuhu kontol on lubatud saata. Ärge korrake saatmist pimesi, kui selle tulemus on ebaselge.
| Väli | Tähendus |
|---|---|
| number | Sihtkoha faksinumber. |
| cidnum | Heakskiidetud saatja helistajanumber. |
| schedule | Plaanitud saatmisaeg, kui seda kasutatakse. |
| faxquality / pagesize / pagerotate | Toetatud kvaliteedi-, paberiformaadi- ja pööramisvalikud. |
| statusemail | Volitatud aadress kohaletoimetamise teavituste jaoks. |
| deleteaftersend | Kas salvestatud üleslaaditud fail tuleks pärast saatmist eemaldada. |
| filename | Selle faksitöövoo oodatav dokumendiviide; mitte suvaline kohaliku faili tee. |
Lõpuleviimise jälgimine
Pärast esitamist kontrollige faksikirje olekut, katseid ja viga. Veenduge kohaletoimetamises; ärge pidage taotluse vastuvõtmist kohaletoimetamiseks. Portaali faksijuhend dokumenteerib selle praegust üleslaadimise ja saatmise töövoogu; selle teed ja autentimine on ülaltoodud lõpp-punktist eraldiseisvad.