Getting Started
- What is the VoxAPI?
- Does it cost me anything?
- Will my customers see that I'm reselling Voxbone Numbers?
- What do I need to run VoxAPI?
- How do I integrate the VoxAPI in my website?
- Where can I find the documentation?
- What is the sandbox?
- What is the Callback feature?
- What are the urls of your API
1. What is the VoxAPI [up]
The VoxAPI is a SOAP based Web Service that will allow you to transparently resell Voxbone Numbers in real time.
Using VoxAPI you will be able to integrate our coverage into your website, manage your Voxbone Numbers and so on.
2. Does it cost me anything? [up]
The VoxAPI is completely FREE! All you pay for are the standard DID purchase charges as in our price list.
3. Will my customers see that I'm reselling Voxbone Numbers? [up]
"No, this is a white label solution.
The API usage is completely transparent as explained before
4. What do I need to run VoxAPI? [up]
To run the VoxAPI you will need the following:
- A running website, with a scripting language such as PHP, Java, .NET, ...
- A connection to a database (any database as it's managed on your side)
- A Voxbone account that has been authorized to access the API
Voxbone enables you to sell and configure Numbers through the API.
To get your account authorized to access our production API, please open a ticket under the API category.
5. How do I integrate the VoxAPI in my website? [up]
We provide an open source SDK (libraries) to help you integrate the VoxAPI.
As these libraries are open source (LGPL licence), we decided to move them to the Sourceforge community.
The Sourceforge project can be found at the following url: http://sourceforge.net/projects/voxbone-client/
If there's no library available for your programming language, please let us know your requirements by opening a ticket under the API category.
6. Where can I find the documentation? [up]
The WSDL (Web Service Description Language ) file can be found on the following URL:
http://sandbox.voxbone.com/VoxAPI/services/VoxAPI?wsdl
Descriptions of all XML requests and responses can be found at http://sandbox.voxbone.com/VoxAPI
More complete documentation will be published on Sourceforge in due course.
7. What is the sandbox? [up]
The sandbox is an isolated testing environment which allow you to test your integration without taking any risk.
Using the sandbox, you will be able to add virtual money to your prepaid account, modify your Numbers configuration without impacting your real Numbers and son on.
To log into the sandbox, you can use your Voxbone username/password.
Please note that every change made to your account parameters are replicated to the sandbox once per day, at 7:00 am GMT
This also concern your account creation, which means your account won't be immediately available on the sandbox.
8. What is the Callback feature? [up]
Let's say for example you want to place an order through the API for Brussels Numbers but unfortunately there's no stock.
You can still place the order by providing the parameter AllowAsynchronous=true.
Once the order has been fulfilled on our side, and if you configured the callback URL, we will send you a request to this page to warn you the order has been fullfiled.
Here's an example of url call for the company ImSellingDIDs:
http://www.ImSellingDIDs.com/callback.php?action=order&reference=&h=&k=
The h and k parameters will be used to secure the transaction, just like the AuthenticationToken of the API.
action will represent the action you should trigger once we hit this page.
In the example above, action=order.
This means that your order has been fulfilled and that you should trigger a getDIDsInfo call to retrieve Numbers provisionned for the specified order reference.
9. What are the urls of your API? [up]
We're currently running 2 servers for our API:
The sandbox: http://sandbox.voxbone.com/VoxAPI/services/VoxAPI?WSDL
The production server: http://www.voxbone.com/VoxAPI/services/VoxAPI?WSDL
Once you finished to test your integration on the sandbox, you can use the production server url to start working with real Numbers.