Webhooks

Webhooks from TTNC come in the form of HTTP POST requests with the HTTP request body consisting of a JSON string containing the relevant information for the webhook event. Which webhook you are receiving will depend on the schema of the JSON. At the bottom of this page, you will find a reference to all webhooks and their particular schemas and information regarding how to set up webhooks in myTTNC.

Webhooks

To set up a webhook, you will first need to create an 'Application' in myTTNC. An Application is used to access the TTNC API allowing changes to be made to your account and numbers, as well as to pull data from your account. Applications can also be used for webhooks.

When creating an Application, you must add a Description, which is simply a friendly name for your reference. You will also need to enter IP addresses which are used to verify access to the TTNC API. At least one IP address is required to create an Application in myTTNC.

You will need to add a URL into the 'Webhook URL' field to receive webhooks, this should be a URL to your system where you are expecting to receive the webhook and its information.

To create an Application follow these simple steps:

1. Log into myTTNC by going to www.myttnc.co.uk.
2. Click on the Account menu drop-down in the top right corner of the page.

3. Click on Integrations from the menu.

4. Click Create VKey

5. Enter the Webhook URL and a Name, if you have the IP Address this can be entered, if not, this can be added at a later date.

6. Click Save and the new Application will be added to the list.

Enable specific webhooks

Once you have created your Application including your webhook URL, you will need to set up each webhook you want to use for each applicable service. This can be done by:

1. Log into myTTNC by going to www.myttnc.co.uk
2. Click on Phone Numbers in the left-hand menu.

3. Click on the three dots next to the number you wish to edit, then click on Edit Settings.

4. Click Integrations

5. Select the name of the 'Application' to be used for the webhook event, and click Save to apply these settings.

Alternatively, click Create New Vkey to setup a new Application, follow the steps at the Top of this guide

📘

Please note:

You can configure webhooks on specific parts of your telephone number setup. For example, if you have Virtual Receptionist, you can set up webhooks for each option individually by navigating to those options settings.

Once the confirmation box appears, the webhook is ready and will start to be sent to your webhook URL as soon as applicable events happen to your telephone number.

Authenticate webhooks from myTTNC

We've also built authentication into our webhooks, in the form of a signed signature sent in the HTTP header, this mean that the source and payload are verified. While not required, it would be good practice to verify the signature before accepting the webhook. The header in question will look like the following;

Webhook-Signature : 098f6bcd4621d373cade4e832627b4f6098f6bcd4621d373cade4e832627b4f6

We sign the body of the POST request with an HMAC SHA256 hex digest, using the Secret Key for the Application held in myTTNC.

The Secret Key can be found in a few simple steps:

1. Log into myTTNC by going to www.myttnc.co.uk.
2. Click on the Account menu drop-down in the top right corner of the page.

3. Click on Integrations from the menu.

4. Click on the three dots next to the row you wish to view the Secret Key of, then click Edit.

5. The Secret Key is displayed in the top right field.

Webhooks for Inbound Calls

Webhooks can be triggered whenever someone makes a call to your virtual telephone number or if you have set it when they select a Virtual Receptionist menu option. This can be done by:

1. Log into myTTNC by going to www.myttnc.co.uk
2. Click on Phone Numbers in the left-hand menu.

3. Click on the three dots next to the number you wish to edit, then click on Edit Settings.

4. Click Integrations

5. Select the name of the 'Application' to be used for Inbound Call from the left-hand drop-down list. Click Save to apply these settings.

Alternatively, click Create New Vkey to set up a new Application, follow the steps at the Top of this guide

You're now ready to receive webhooks. The following information outlines how the data will be sent to you and details about what each field means in relation to the event.

JSON Payload (start of call & call progress)

When this webhook is enabled, you will receive a JSON payload whenever a caller dials the TTNC Number in question. You will also receive a JSON payload whenever the caller moves through any option based menus if you have set up the webhook on these menu options.

{
   "event" : {
       "anumber" : "01245012345",
       "anumber_contact_name": "Office",
       "bnumber" : "02031511000",
       "bnumber_tags" : [],
       "bnumber_alias" : "Main Line",
       "call_date" : "2016-05-24",
       "call_time" : "11:14:39",
       "option" : "-",
       "ref" : "!5442B5AD54E14",
       "event_type" : "incoming_call"
   }
}

JSON Payload (call roundup)

When this webhook is enabled, you will receive a JSON payload whenever a call finishes. This will contain all of the information for the call, including the duration of the call, call cost and several other pieces of information explained below;

{
   "event": {
       "ref": "!8D3B9C8356C04",
       "call_date": "2016-05-24",
       "call_time": "11:14:39",
       "anumber" : "01245012345",
       "anumber_contact_name": "Office",
       "anumber_type": "UK Chelmsford",
       "bnumber" : "02031511000",
       "bnumber_tags" : [],
       "bnumber_alias" : "Main Line",
       "bnumber_type": "UK London",
       "dialled": "447777777777",
       "dialled_type": "UK Mobile",
       "duration": "45",
       "duration_system": "45",
       "cost": 0.075,
       "reason": "1",
       "reason_q805": "16",
       "event_type": "cdr"
   }
}

CDR Reasons

The reason numerical value can be interpreted as follows.

Webhooks for Inbound SMS messages

Webhooks can be triggered whenever an SMS is received. This can be done by:

1. Log into myTTNC by going to www.myttnc.co.uk
2. Click on Phone Numbers in the left-hand menu.

3. Click on the three dots next to the number you wish to edit, then click on Edit Settings.

4. Click Integrations

5. Select the name of the 'Application' to be used for Inbound SMS from the right-hand drop-down list. Click Save to apply these settings.

Alternatively, click Create New Vkey to set up a new Application, follow the steps at the Top of this guide

As soon as you've confirmed the webhook settings, we'll start sending webhook notifications to you webhook URL whenever an SMS is received to your number. The following information outlines how the data will be sent to you, and details about what each field means in relation to the event.

{
    "event": {
        "event_type" : "incoming_sms",
        "originator" : "44777777777",
        "bnumber" : "02031511000",
        "sms_date" : "2016-05-24",
        "sms_time" : "11:29:48",
        "message_id" : 363723,
        "message" : "This is a test message",
        "udh" : "0500035D0302"
    }
}

Set up or remove Webhook Applications for a number

SetApplication

Description

This allows you to set up, change or remove which myTTNC Application is being used for particular webhooks on a number.

To get a successful response, at least one of the optional parameters must be sent. It is possible to send several of the optional parameters together in one request, as shown in the examples below.

<?xml version="1.0"?>
<NoveroRequest>
    <Request target="NoveroNumbers" name="SetApplication" id="TestRequest">
        <Number>01245123456</Number>
        <call_api_vkey_id>999</call_api_vkey_id>
        <sms_api_vkey_id>999</sms_api_vkey_id>
    </Request>
</NoveroRequest>

<?php
    require_once('TTNCApi.php');
    $Api = new TTNCApi('<username>', '<password>', '<VKey>');
    $Request = $Api->NewRequest('NoveroNumbers', 'AddTag', 'TestRequest');
    $Request->SetData('Number', '01245123456');
    $Request->SetData('call_api_vkey_id', 999);
    $Request->SetData('sms_api_vkey_id', 999);
    $Api->MakeRequests();
    $Response = $Api->GetResponseFromId('TestRequest');
?>

require TTNCApi
api = TTNCApi.new('<username>', '<password>', '<vkey>')
request = api.newrequest('NoveroNumbers', 'SetApplication', 'TestRequest')
request.setdata('Number', '01245123456')
request.setdata('call_api_vkey_id', 999)
request.setdata('sms_api_vkey_id', 999)
api.makerequest()
p request.getresponse()

api = TTNCApi('<username>', '<password>', '<vkey>')
request = api.newrequest('NoveroNumbers', 'SetApplication', 'TestRequest')
request.setdata('Number', '01245123456')
request.setdata('call_api_vkey_id', 999)
request.setdata('sms_api_vkey_id', 999)
api.makerequest()
p request.getresponse()

using System;
using TTNCApi;
 
class Program
{
    static void Main(string[] args)
    {
        TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
        TTNCRequest request = api.NewRequest("NoveroNumbers", "SetApplication", "TestRequest");
        request.setData("Number", "01245123456");
        request.setData("call_api_vkey_id", 999);
        request.setData("sms_api_vkey_id", 999);
        api.MakeRequests();
        TTNCParser dic = request.GetResponse();
     }
}

Response

<?xml version="1.0"?>
<NoveroResponse>
    <Response target="NoveroNumbers" name="SetApplication" Code="200" RequestId="TestRequest">
        <ResponseMessage>Application set successfully</ResponseMessage>
        <Success>Application set successfully</Success>
    </Response>
</NoveroResponse>