Use HTTPS and HTTP Basic authentication with approved API credentials. Keep credentials on your application server. These Hosted PBX endpoints use /hpbx/ on api.multitel.net; do not insert /v3. Check both the HTTP result and the application status in the JSON response.
Read fax records
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Replace the billing code with your PBX. Returned records include fax time, direction, source, destination, delivery status, attempts, errors and page count. Delivery can still be pending when a send request is accepted.
Sending parameters
The send endpoint is POST /hpbx/fax/send/{billing_code}. Sending is a live action. Prepare the file and account-authorized destination before submitting; do not retry an uncertain send blindly.
| Field | Meaning |
|---|---|
| number | Destination fax number. |
| cidnum | Approved sending caller ID. |
| schedule | Scheduled send time, when used. |
| faxquality / pagesize / pagerotate | Supported quality, paper size and rotation options. |
| statusemail | Authorized address for delivery notifications. |
| deleteaftersend | Whether the stored upload should be removed after sending. |
| filename | The document reference expected by this fax workflow; not an arbitrary local file path. |
Track completion
After submission, inspect the fax record’s status, attempts and error. Confirm delivery rather than interpreting acceptance as delivery. The portal fax reference documents its current upload and send workflow; its paths and authentication are separate from the endpoint above.