Hosted-PBX-API: Faxdatensätze und -versand

Verwenden Sie HTTPS und HTTP-Basic-Authentifizierung mit genehmigten API-Zugangsdaten. Bewahren Sie die Zugangsdaten auf Ihrem Anwendungsserver auf. Diese Hosted-PBX-Endpunkte verwenden /hpbx/ auf api.multitel.net; fügen Sie nicht /v3 ein. Prüfen Sie sowohl das HTTP-Ergebnis als auch den Anwendungsstatus in der JSON-Antwort.

Faxeinträge lesen

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

Ersetzen Sie den Abrechnungscode durch den Abrechnungscode Ihrer PBX. Zurückgegebene Datensätze umfassen Faxzeit, Richtung, Quelle, Ziel, Zustellstatus, Versuche, Fehler und Seitenanzahl. Die Zustellung kann noch ausstehend sein, wenn eine Sendeanforderung akzeptiert wird.

Sendeparameter

Der Sende-Endpunkt ist POST /hpbx/fax/send/{billing_code}. Das Senden führt einen echten Versand aus. Bereiten Sie die Datei und das kontoberechtigte Ziel vor dem Absenden vor; wiederholen Sie einen unsicheren Sendevorgang nicht blind.

FeldBedeutung
numberZiel-Faxnummer.
cidnumGenehmigte Absenderrufnummer.
scheduleGeplante Sendezeit, sofern verwendet.
faxquality / pagesize / pagerotateUnterstützte Qualitäts-, Papierformat- und Rotationsoptionen.
statusemailAutorisierte Adresse für Zustellbenachrichtigungen.
deleteaftersendOb die hochgeladene und gespeicherte Datei nach dem Senden entfernt werden soll.
filenameDie von diesem Fax-Workflow erwartete Dokumentreferenz; kein beliebiger lokaler Dateipfad.

Abschluss verfolgen

Prüfen Sie nach dem Absenden Status, Versuche und Fehler des Faxdatensatzes. Bestätigen Sie die Zustellung, statt die Annahme als Zustellung zu interpretieren. Die Portal-Faxreferenz dokumentiert den aktuellen Upload- und Sendeablauf; deren Pfade und Authentifizierung sind vom oben genannten Endpunkt getrennt.

Dokumentation suchen