Hosted PBX API: faxrecords en verzending

Gebruik HTTPS en HTTP Basic-authenticatie met goedgekeurde API-inloggegevens. Bewaar inloggegevens op uw applicatieserver. Deze Hosted PBX-endpoints gebruiken /hpbx/ op api.multitel.net; voeg /v3 niet in. Controleer zowel het HTTP-resultaat als de applicatiestatus in het JSON-antwoord.

Faxrecords lezen

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

Vervang de factureringscode door die van uw PBX. De geretourneerde records bevatten faxtijd, richting, bron, bestemming, afleverstatus, pogingen, fouten en aantal pagina's. De aflevering kan nog in behandeling zijn wanneer een verzendverzoek is geaccepteerd.

Verzendparameters

Het verzendeindpunt is POST /hpbx/fax/send/{billing_code}. Verzenden is een live-actie. Bereid het bestand en de voor uw account geautoriseerde bestemming voor voordat u indient; probeer een onzekere verzending niet blindelings opnieuw.

VeldBetekenis
numberBestemmingsfaxnummer.
cidnumGoedgekeurd beller-ID van de afzender.
scheduleGeplande verzendtijd, indien gebruikt.
faxquality / pagesize / pagerotateOndersteunde kwaliteit, papierformaat en rotatieopties.
statusemailGeautoriseerd adres voor bezorgmeldingen.
deleteaftersendOf de opgeslagen upload na verzending moet worden verwijderd.
filenameDe documentverwijzing die deze faxworkflow verwacht; geen willekeurig lokaal bestandspad.

Voltooiing volgen

Controleer na indiening de status, pogingen en fout van het faxrecord. Bevestig de bezorging in plaats van acceptatie als bezorging te interpreteren. De portaalfaxreferentie documenteert de huidige workflow voor uploaden en verzenden; de paden en authenticatie ervan staan los van het bovenstaande eindpunt.

Documentatie zoeken