VoxAPI

VoxAPI, or Voxbone’s Application Programming Interface, is a Web module that enables Voxbone customers to automate the ordering and configuration of phone numbers and channels. It is a SOAP and REST-based web service that allows Voxbone customers to integrate number ordering and configuration functions with any of their front or back-office applications. Communications between customer applications and Voxbone's API are secured through HTTP basic authentication over SSL.

Functionalities:

  • Retrieve Voxbone's coverage and price list
  • Retrieve a full direct inward dialing (DID) list in an account
  • Retrieve stock for a specific area
  • Map numbers to capacity groups, channels and URIs
  • Configure codecs and allowed services
  • Retrieve a current account balance
  • Purchase credits for Vox800 and VoxSMS
  • Purchase or cancel numbers
  • Purchase channels
  • Retrieve Voxbone's POP list
  • Check and track order status
  • Download CDRs
  • Manage regulation requirements
  • Enables white-labeled resale
  • XML/SOAP, XML/REST or JSON/REST over HTTPS
  • Automated ordering and configuration
  • Access control and authentication security
  • Voxbone developer support

VoxAPI Brochure

VoxAPI Enabler

Download.pdf

Documentation

Voxbone provides the following documentation:

1/ A general API guide for technical project managers and developers. This guide provides an overview of Voxone’s API features. https://www.voxbone.com/resources/VoxboneApiGuide.pdf

2/ In-depth technical documentation for developers including examples of clients in different programming languages. https://www.voxbone.com/apidoc/

3/ A WSDL (SOAP)/WADL (REST) file that provides you with the basic information to start coding your applications using our VoxAPI https://www.voxbone.com/ws-voxbone/services

Please note that our documentation will continue to evolve. Please check here regularly for the latest versions.

Sandbox

The API Sandbox is an isolated testing environment that allows developers to test their integration with VoxAPI without any risk. In the Sandbox, you can order virtual DIDs, add virtual money to your business account and modify the configuration of your virtual DIDs.

The Sandbox is only available for customers with an API-enabled account. To register for a free account, please visit https://www.voxbone.com/register.jsf and contact Voxbone to ask to enable the API.