Använd HTTPS och HTTP Basic-autentisering med godkända API-inloggningsuppgifter. Förvara inloggningsuppgifterna på din applikationsserver. Dessa Hosted PBX-ändpunkter använder /hpbx/ på api.multitel.net; infoga inte /v3. Kontrollera både HTTP-resultatet och åtgärdens status i JSON-svaret.
Läs faxposter
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Ersätt exemplets faktureringskod med koden för din PBX. Returnerade poster inkluderar faxtid, riktning, källa, destination, leveransstatus, försök, fel och sidantal. Leveransen kan fortfarande vara väntande när en sändningsbegäran accepteras.
Parametrar för sändning
Slutpunkten för sändning är POST /hpbx/fax/send/{billing_code}. När du skickar utförs en verklig sändning. Förbered filen och en destination som kontot har behörighet att skicka till innan du skickar; upprepa inte en sändning på måfå när resultatet är osäkert.
| Fält | Betydelse |
|---|---|
| number | Destinationens faxnummer. |
| cidnum | Godkänt avsändar-ID för utgående samtal. |
| schedule | Schemalagd sändningstid, när den används. |
| faxquality / pagesize / pagerotate | Kvalitets-, pappersstorleks- och rotationsalternativ som stöds. |
| statusemail | Behörig adress för leveransaviseringar. |
| deleteaftersend | Om den lagrade uppladdningen ska tas bort efter sändning. |
| filename | Den dokumentreferens som detta faxarbetsflöde förväntar sig; inte en godtycklig lokal filsökväg. |
Spåra slutförande
Efter inskickning, kontrollera faxpostens status, försök och fel. Bekräfta leverans i stället för att tolka att faxet har accepterats som att det har levererats. Portalens faxdokumentation dokumenterar det aktuella arbetsflödet för uppladdning och sändning; dess sökvägar och autentisering är separata från slutpunkten ovan.