Get to know the Dial 9 API

New Features and Tips & Tricks

For those of you that are developers (especially our Codebase and Deploy customers that use Dial 9), you'll be pleased to know we have now deployed our new Dial 9 API!

We have a large list of methods available, including:

  • Adding, updating and deleting address contacts
  • Viewing Call Groups
  • Viewing Call Logs
  • Downloading / deleting recordings
  • Viewing Call Queues
  • Viewing Conference Rooms
  • Adding or updating extensions
  • Viewing virtual Fax Machines
  • Viewing Follow Mes
  • Viewing IVR Menus
  • Adding/Purchasing and configuring numbers, as well as updating subscriber information
  • Viewing Pickup groups
  • Viewing and activating presets
  • Listing unit information (for wholesale customers)
  • Viewing uploaded music/audio files

Our full API docs can be found via our API Documentation.

To authenticate, you'll just need to send X-Auth-Token and X-Auth-Secret headers along with your request, using a token that you can generate from within your Dial 9 service in the Connect portal.

You'll see in the below example a simple call and response when requesting a list of active calls using the appropriate API method:

The Request

$ curl https://connectapi.dial9.co.uk/api/v2/logs/active \
    -H "X-Auth-Token: my-token" \
    -H "X-Auth-Secret: my-secret"

The Response

{
    "status":"success",
    "time":0.07,
    "flags":{},
    "data":
    [
        {
            "call_type":"outgoing",
            "duration":"00:00:18",
            "state":"Connected",
            "from":
                {
                    "type":"Extension",
                    "object":
                        {
                           "id":2902,
                            "name":"adamw",
                            "exten":"100"
                       }
                },
            "to":
                {
                    "type":"String",
                    "object":"44700123456"
                }
        } 
    ]
}

As always, please let us know if you have any questions, either by email to support@dial9.co.uk, or by phone to 01202 912444.

A little bit about the author

Adam is the Head of Software at Krystal. Adam looks after our software engineering team by day and, when not doing that, enjoys hobbies including LEGO, collecting playing cards, building mechanical keyboards and home automation.