API Reference & Collections
Machine-readable definitions of the VoicerOnePBX REST API — browse it interactively, or import it straight into your tooling.
Interactive reference
Browse every endpoint, parameter and schema in a clean, searchable view (opens in a new tab).
OpenAPI 3 spec
Download voiceronepbx-openapi.yaml — feed it to code generators, Swagger Editor, or your IDE.
Postman collection
Import voiceronepbx-postman.json and click through every request with variables pre-wired.
Importing
- Postman — Import → drop in
voiceronepbx-postman.json. Set the collection variablesbaseUrl(e.g.https://your-pbx:8085) andtoken, and every request is ready to send. - Swagger / OpenAPI tools — open
voiceronepbx-openapi.yamlin the Swagger Editor, or generate a typed client withopenapi-generator.
Endpoints at a glance
| Method | Path | Purpose |
|---|---|---|
| POST | /api/fax | Send a fax (base64 PDF, optional cover, status callback) |
| POST | /api/sms | Send an SMS |
| POST | /api/email | Send an email (html/text, optional attachment) |
| POST | /api/reminders | Schedule appointment-reminder calls |
| POST | /api/voice/originate | Place a call and drive it with programmable voice |
| GET | /api/inbox/faxes | List received faxes (+ media URL) |
| GET | /api/inbox/sms | List inbound text messages |
| GET | /api/inbox/voicemails | List voicemail for a mailbox (+ transcript & audio) |
All authenticated the same way
Every endpoint uses the same Bearer token. The spec declares it as the
bearerAuth security scheme, so your generated client or Postman environment only needs the token set
once.