Käytä HTTPS:ää ja HTTP Basic -todennusta hyväksytyillä API-tunnuksilla. Säilytä tunnukset sovelluspalvelimellasi. Nämä Hosted PBX -päätepisteet käyttävät kohdetta /hpbx/ kohteessa api.multitel.net; älä lisää kohdetta /v3. Tarkista sekä HTTP-tulos että toiminnon tila JSON-vastauksessa.
Lue faksitietueet
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Korvaa esimerkin laskutuskoodi oman PBX:si koodilla. Palautetut tietueet sisältävät faksin ajan, suunnan, lähteen, määränpään, toimitustilan, yritykset, virheet ja sivumäärän. Toimitus voi olla vielä kesken, kun lähetyspyyntö hyväksytään.
Lähetysparametrit
Lähetyksen rajapintaosoite on POST /hpbx/fax/send/{billing_code}. Lähettäminen suorittaa todellisen lähetyksen. Valmistele tiedosto ja kohde, johon tilillä on lupa lähettää, ennen lähettämistä. Älä toista lähetystä summittaisesti, jos sen tulos on epäselvä.
| Kenttä | Merkitys |
|---|---|
| number | Kohdefaksinumero. |
| cidnum | Hyväksytty lähettäjän Caller ID. |
| schedule | Ajastettu lähetysaika, kun käytössä. |
| faxquality / pagesize / pagerotate | Tuetut laatu-, paperikoko- ja kiertovaihtoehdot. |
| statusemail | Valtuutettu osoite toimitusilmoituksille. |
| deleteaftersend | Määrittää, poistetaanko tallennettu tiedosto lähettämisen jälkeen. |
| filename | Tämän faksityönkulun odottama dokumenttiviite; ei mielivaltainen paikallinen tiedostopolku. |
Seuraa valmistumista
Tarkista lähetyksen jälkeen faksitietueen tila, yritykset ja virhe. Varmista toimitus äläkä tulkitse pyynnön vastaanottamista toimitukseksi. Portaalin faksiohje kuvaa sen nykyisen lataus- ja lähetystyönkulun; sen polut ja todennus ovat erillisiä yllä olevasta päätepisteestä.