API - Application Programming Interface

Use our Developer API to start integrating with our systems today

We've designed the TTNC Developer API for people who want to take their telephone management to the next level. Using the same industry leading technology which runs our control panel; myTTNC, we've created a world class API for developers to build their own applications and integrate directly with our core services and numbering. The possibilities are endless and the opportunities untold.

Priority number one - on demand, real time call data

The single most important thing with a telephone number is the calls you get. This is why we make sure that you have full on demand access to download or stream all of the call data, voicemails, call recordings and faxes that your numbers receive. Either pull the data as and when you need it or store it locally within your own systems.

Webhooks

At their simplest level, a webhook is a way of one system instantly sending information about an event to another entirely separate system.

For your telephone numbers what this means is whenever a call comes in to a TTNC virtual number, your own systems can receive information about the call instantly from our network. For example you could populate information about the caller into your CRM system before your operator has even answered the call; it'll be ready and waiting for them.

To use webhooks, you'll need to have some technical development resource, just like if you wanted to use our direct API. When a webhook is 'triggered' we send the information of the call straight to your system over the Internet. Your system must be coded and ready to receive the information, and subsequently do something with it.


Accessing the API

Access to the API is included, for free, with all accounts. To enable API access you will need to set up an application key (VKey) - this can be done by following to steps in the next section.

You'll also need to provide the IP addresses of your development and test environments for us to permit API access.


Creating a VKey

To create a webhook, or to access our API you will need to set up a VKey. This will allow you to extract and interact with data in your account from an external source.

To set up a VKey:

  1. Log into myTTNC, then navigate to Accounts, and Applications.
  2. Click on the green 'Generate new VKey' button.
  3. Enter a VKey Description (this will only show when we associate the application with the TTNC number).
  4. Webhook URL can be blank.
  5. Enter the IP Address you'll be making requests from. This can be 0.0.0.0 if you don't have a static IP. This is used to verify access to the TTNC API. This will not be used for webhooks but is required to create an Application in myTTNC
  6. Click the 'Create VKey' button.

For more information see the Webhooks page.


Understanding API Requests

The API uses XML to communicate requests to and from the server. The XML should be sent as POST data directly to the API URL. Multiple API requests can be sent for each POST to apply a full configuration in one transaction.

Sending API Request

API requests can be sent using your programming language of choice on any platform, provided that the computer sending the requests has had its IP address permitted for access (see 'Accessing the API' above). All API requests should be POSTed to the following URL;

https://xml.ttnc.co.uk

Formatting of API Requests

The XML document should always start with the opening tag NoveroRequest and finish by closing it; /NoveroRequest. Inside of these tags, multiple API requests can be queued using the Request tag. The requests are processed in the order they are placed in the XML. The Request tag should have 3 attributes attached; name, target and id. The name and the target are references to the type of request you wish to perform and the id, while not required, is used to 'tag' the request for easy retrieval from the response.

<?xml version="1.0"?>
<NoveroRequest>
    <Request target="..." name="..." id="Request1">
 
        /* First API Request */
 
    </Request>
    <Request target="..." name="..." id="Request2">
 
        /* Second API Request */
 
    </Request>
</NoveroRequest>

Understanding API Responses

Upon the API receive one of more Request calls, a response will be given to each in the order they were received. If the Request was tagged with an id, the same id will be an attribute on the Response; so you can easily identify which Response relates to which Request. In addition to the id, each Response also includes a code attribute. This is the return code of the Response, a 200 code indicates a successful request, anything else is a failure and the response will include reasons for the failure.

<?xml version="1.0"?>
<NoveroResponse>
    <Response target="..." name="..." Code="200" RequestId="Request1">
 
        /* Response XML */
 
    </Response>
    <Response target="..." name="..." Code="200" RequestId="Request2">
 
        /* Response XML */
 
    </Response>
</NoveroResponse>

📘

Starting up

You'll need an account; simply search for and purchase a number to get started. You'll be ready in minutes and can issue yourself with API access through your account.

We have Client Libraries available in several languages to help you interface with our XML and JSON schema, however you are of course free to develop your own Client Libraries or 'wrapper class' to suit your own needs.

Our Help Centre contains all of our documentation, sample code and Client Libraries and is updated on a regular basis as new features become available.

Updated 2 months ago


API - Application Programming Interface


Use our Developer API to start integrating with our systems today

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.