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.
Choose the number and PBX
The endpoint shape is POST /hpbx/dids/{operation}/{billing_code}. Supported operations include create, edit and delete. The billing code must identify a PBX belonging to the authenticated account. A routing record does not purchase a new public telephone number.
Routing fields
| Field | Purpose |
|---|---|
| number / fullnumber | The DID represented by the PBX routing record. |
| comment | An administrator-facing description. |
| maxchannels | The PBX route’s maximum concurrent calls. |
| destination | Ordered destination values for the selected PBX. |
| unconditional | An unconditional forwarding destination when used. |
| cnam | Caller-name lookup setting; usage charges can apply. |
| recording | Recording policy: no, yes, yeschange or nochange. |
| di_emailrecording / di_minemailrecording | Recording email destination and minimum duration. |
| allowemergency / emergencynotes | Emergency caller-ID settings; these do not register an emergency address. |
| didprefix / didnameprefix | Caller-number/name prefixes. |
| fax / faxprotocol / faxstore / faxemail | Fax detection, protocol and delivery/storage choices. |
| sms_destination / di_smstofield / di_sms_store | Enabled message delivery/storage settings. |
Prepare valid destinations
Destination values must come from the selected PBX; the former Array() sample was not a JSON or form payload. Resolve extensions, IVRs or groups before constructing the request. Use the current number-routing schema for the API surface you are integrating with.
Verify the result
Inspect application status, reopen the number’s configuration and make a controlled inbound call. Check busy, no-answer, timeout and recording/fax/message paths separately. Follow the portal routing guide for a step-by-step configuration.