Developer Newsletter


Voxbone Developer Newsletter - Nov 17
Welcome to the first issue of the Voxbone API Developer newsletter.

We are going to make this a bi-monthly newsletter where we will cover everything from the APIs themselves to new resources and API updates, trending topics and the exciting roadmap of features we have planned for the Voxbone API.

You can forward this onto any of your colleagues or developers who may be interested.


  1. Recap of the new Italian regulations
  2. Further updates on the API V3 coming up in November
  3. What else do we have planned for the month’s ahead?
  4. Engaging with you – our developer customers
  5. What else would you like to see in this newsletter?
Recap of changes:

  • Method: listDIDGroup
    The proofRequired Boolean field in the regulation parameters returned by this method will return true if either (or both) proof of ID or Proof of Address is required.
  • Method: createRegulationAddress
    We now have new extra fields to support the new Italian regulation
    (including the identityProofObject).

To avoid problems, please again try to ensure that the DID Type you created the address with matches the DIDType you are linking the address with.

As part of rolling out our brand new VoxOut International service that enables outbound termination on DIDs enabled in 37 countries, we have made some changes to allow you to access this feature from within the API.

Summary of changes made

listFeature method now has a new feature type which will be returned for DIDs that support Voice. The feature type is VoxOUT International with featureID = 51.

listDIDGroup method has a change in both request and response.

Request: Client can add the new value for VoxOUT International found through the
listFeature method in the query parameter featureIds.

Request: The DIDgroups with the new feature enabled will be returned.

We have also introduced a new configuration method that is be mandatory for applying VoxOutInternational changes to a DID. The key difference in this method is that you can only apply the configuration to one DID at a time (instead of a range). This will ensure that the error messages for incomplete configuration provide more clarity on the impacted numbers in your application. It is recommended to use this method for all your existing configuration changes as well.


In the past year, as API product Manager, I have found a lot of errors in the API documentation and the quality of the material that we have on our developer site. APIs are supposed to connect engineers and allow for the sharing of great developments. APIs let companies like Voxbone add value to other products and create an eco-system of shared knowledge. But an API is only valuable if it’s accessible. And for that, it needs clear documentation.

Enter Swagger – a tool to provide automated API documentation ensuring that our developers are never caught out with incorrect fields or documentation! Swagger only supports REST APIs so for those of our customers using SOAP, we hope to ensure that we have solution for you soon as well!

What is Swagger?

Swagger is a set of rules (in other words, a specification) for a format describing REST APIs. The format is both machine-readable and human-readable. It provides our developers the ability to easily try any API request. For more about Swagger, read here:


As part of our initiative to improve our customer engagement on APIs, we are coming up with a series of initiatives (including this newsletter) that we would like to roll out in 2018

  1. Developer Hour – We would like to invite you you all for a 45 minute bi-monthly webinar with me and one of our developers to answer any API related questions that you have. For those of you looking to get started on using our APIs, this would be a great opportunity to have those niggling doubts answered before you get started!Details on the first Developer Hour in 2018 will be posted on the new developer portal and I will put some more details in my next newsletter as well.
  2. Ask Us – This will be a new section in this newsletter where I pick a few interesting support tickets raised over the past few months and address them here for everyone’s benefit (Don’t worry – we won’t be sharing the details of the customers who raised these requests)

Enabling API access on your accounts:

We only allow access to the Voxbone API for our active customers. So if you are a free trial or testing account, please note that API access will not be available at the moment. However, you can still look through the available examples and overview on our developer website.

For our active customers, you can enable API access yourself through the Service Overview section on the webportal:

You can alternately ask your Account Manager to enable this access for you. For subaccounts, currently this will need to be done through your account manager or a support ticket only.

Don’t forget to change or set your API password before you start. Note that to use the API and the Sandbox application, you will need to use your API password and not your portal password.

Note: The issues we have had with our sandbox have now been resolved. Thank you for your patience while we resolved this.

Addressing a question from some of our customers here:

Existing Italian addresses within your database cannot be used for the latest Italian regulations since there is a gap in the data needed. If you would like to reuse data from existing addresses, then please do the following:

  1. Use the listRegulationAddress method and filter the response on countrycodeA3 = ITA. Get the information from here and
  2. Feed the information from the above method into the same fields in a new CreateRegulationAddress method request along providing the additional information requirements in the extra fields and uploading Proof of ID documents

To avoid problems, please again try to ensure that the DID Type you created the address with matches the DIDType you are linking the address with.


Reply to this email with your thoughts and ideas on what else you would like to see in this bi-monthly newsletter.

We would love to hear from you.