VoxAPI

VoxAPI, or 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 (Simple Object Access Protocol)-based Web service that allows 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 IP address-based access control, SHA-1 authentication security and SOAP over HTTPS support.

Functionalities:

  • Retrieve Voxbone's coverage and price list
  • Purchase or cancel numbers
  • 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 services allowed
  • Retrieve a current account balance
  • Retrieve a prepaid account balance
  • Purchase credit for Vox800 and VoxSMS
  • Retrieve Voxbone's PoP list
  • Check and track order status
  • Enables white-labeled resale
  • SOAP over HTTPS
  • Automated ordering and configuration
  • Access control and authentication security
  • Voxbone developer support

VoxAPI Brochure

VoxAPI Enabler

Download.pdf

Documentation

Voxbone provides an open-source software development kit (SDK libraries) to help developers integrate VoxAPI. Because these libraries are open-source (LGPL license), Voxbone has made them publicly available to the SourceForge community. A description of all XML requests and responses offered by VoxAPI can be found on http://sourceforge.net/projects/voxbone-client/

The WSDL (Web Service Description Language) file can be found at http://sandbox.voxbone.com/VoxAPI/services/VoxAPI?wsdl

Descriptions of all XML requests and responses can be found at http://sandbox.voxbone.com/VoxAPI

Sandbox

The API Sandbox is an isolated testing environment that allows developers to test their integration with VoxAPI without any risk. Using the sandbox, customers can virtually order numbers, add money to their prepaid accounts and modify number configuration.

The Sandbox is only available for registered users. To register for a free account, please visit http://www.voxbone.com/register.jsf. To log into the sandbox, you can use the same username and password as for accessing our web portal. To get started, you need to specify the IP address you will be accessing the sandbox from on https://www.voxbone.com/members/allowedIPAddress.jsf. Please note that all changes made to your account parameters are replicated to the sandbox once a day at 7 a.m. GMT. In practice this means that you will only be able to access the sandbox the day after you have created your account and specified your IP address.