API vir gehuisveste PBX: faksrekords en versending

Gebruik HTTPS en HTTP Basic-stawing met goedgekeurde API-stawingsbesonderhede. Hou stawingsbesonderhede op jou toepassingbediener. Hierdie gehuisveste PBX-eindpunte gebruik /hpbx/ op api.multitel.net; moenie /v3 invoeg nie. Gaan beide die HTTP-resultaat en die toepassingstatus in die JSON-antwoord na.

Lees faksrekords

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

Gebruik jou PBX se faktureringskode. Die teruggestuurde rekords bevat die fakstyd, rigting, bron, bestemming, afleweringstatus, pogings, foute en aantal bladsye. Aflewering kan steeds hangende wees wanneer ’n stuurversoek aanvaar word.

Stuurparameters

Die stuureindpunt is POST /hpbx/fax/send/{billing_code}. Indiening stuur die lêer werklik. Berei die lêer en die bestemming wat vir die rekening gemagtig is voor voordat jy dit indien; moenie blindelings weer stuur as jy onseker is of die vorige poging geslaag het nie.

VeldBetekenis
numberBestemming-faksnommer.
cidnumGoedgekeurde sender-beller-ID.
scheduleGeskeduleerde stuurtyd, wanneer gebruik.
faxquality / pagesize / pagerotateOndersteunde gehalte-, papiergrootte- en rotasie-opsies.
statusemailGemagtigde adres vir afleweringskennisgewings.
deleteaftersendOf die gestoorde, opgelaaide lêer ná versending verwyder moet word.
filenameDie dokumentverwysing wat hierdie faksverloop verwag; nie 'n willekeurige plaaslike lêerpad nie.

Volg voltooiing

Inspekteer na indiening die faksrekord se status, pogings en fout. Bevestig aflewering eerder as om aanvaarding as aflewering te interpreteer. Die portaal-faksverwysing dokumenteer sy huidige oplaai- en stuurwerkvloei; sy paaie en verifikasie is apart van die eindpunt hierbo.

Soek dokumentasie