Skip to content
Docs
Voice PBX
All endpoints

Voxbi PBX Api

OpenAPI 3.1.0 v1.0.4+e08a93f90c44264b2f5baf632d512f820f76560d-master

Voxbi PBX Web Api. This API is used to communicate with the VOXBI PBX.

Functions:

  • Phone Interactions (Deployment and Status changes)
  • Call actions : Control Calls remotely
  • Phone Control : Control Phones remotely

Currently supported phone vendors for web api:

  • Phone Interactions : Yealink
  • Phone Control : Yealink

System Version: 1.0.4+e08a93f90c44264b2f5baf632d512f820f76560d-master | Module: PBX - Web [1.0.4+e08a93f90c44264b2f5baf632d512f820f76560d-master] | Framework: 1.0.0

Servers
  • Voxbi PBX system https://{username}.voxbi.cloud/api/{version}
Authentication
  • SipDevice Auth Username in Query API key in query "username"
  • SipDevice Auth Password in Query API key in query "password"
  • User Auth Username in Query API key in query "username"
  • User Auth Password inQuery API key in query "password"
  • User Auth in Basic Header Basic token
  • Instance ApiKey in Query API key in query "key"
  • Instance ApiKey in Bearer Header Bearer token

v1

Version 1 of the api

get /calls/new/tapi Start new call post /calls/placemulticast Start a new multicast announcement post /calls/hangup Hangup calls post /calls/new Start new call get /phoneControl/action Control your phone post /smartIvr/callback Smart IVR AI callback

Phone

Actions used by the phones to interact with the PBX

get /phone/enableCallFlow Toggle / Enable / Disable a call flow from a phone get /phone/deployment Deployment for phone get /phone/directory Get the directory for phones get /phone/dnd[/{status}] Enable / Disable DND from a phone get /phone/forwards Enable / Disable forwards from a phone get /user/forwards Enable / Disable forwards for a user via a button get /phone/deployment/gigaset/{key}/{filename} Deployment for Gigaset get /phone/directory/gigaset/{key} Get the directory for Gigaset devices get /phone/options/info Class OptionsController get /phone/options/sync Class SyncController get /phone/options Get options menu for phones

User

Actions to interact with the Users endpoints

get /user Get user info

Server

Actions to interact with the Server endpoints

get / System status

cors

cors

options /* Cors Options Request