Welcome to the introduction of the Telserv API v2!
If this is your first visit, please take a moment to read the information below. Otherwise, feel free to skip directly to the API reference.
The API is only accessible from whitelisted IP addresses. You can manage your whitelist on the Telserv portal. You'll need to be logged in as an administrator.
There are two environments: SANDBOX and LIVE.
LIVE, of course, is the production environment. Bought a number? You'll be charged. Incorrectly updated a destination? Calls may no longer reach you. Cancelled a number? You have set wheels in motion that we are unable to stop.
SANDBOX, on the other hand, let's you do anything without ever having to worry about the consequences. This comes at a price though: every Sunday morning, SANDBOX is discarded and re-synced from LIVE, so don't panic if you can no longer find those changes you made! Oh, and yes, it also means that SANDBOX is not available during that timeframe.
Obviously, each environment runs on its own URL. Also, to minimize unintended cross-pollination, you will have a separate API key for each environment. You should take care to separate sufficiently on your end as well, because requests to undo unintended changes on production will first be ridiculed and then denied.
You can retrieve your API keys on the Telserv portal. You'll need to be logged in as an administrator.
In every request, include your API key in an HTTP header called X-ApiKey.
Anxious to get going? The API reference lives here. This probably won't be the first API you're developing against, so it should all be pretty self-explanatory.
We will not implement breaking changes without sufficient prior notification.
We will implement non-breaking changes (such as a new optional parameter, a new method, or a new property for an existing class) as we see fit.
Changes are recorded in the changelog.