Example payloads

OutgoingCall

{
  "payload":{
    "event":"OutgoingCall",
    "call_id":"3dc54a92-aaaf-11e7-b600-7ac8e42434d2",
    "callee_number":"441202901222",
    "caller_number":"01202912204"
  },
  "timestamp":1507305529,
  "auth_token":"my-token"
}

IncomingCall

{
  "payload":{
    "event":"IncomingCall",
    "call_id":"2f533604-aaaf-11e7-b600-7ac8e42434d2",
    "callee_number":"01202912204",
    "caller_number":"01202901222"
  },
  "timestamp":1507305504,
  "auth_token":"my-token"
}

CallProcessed

{
  "payload":{
    "event":"CallProcessed",
    "call_id":"2f533604-aaaf-11e7-b600-7ac8e42434d2",
    "call_cost":0.0,
    "call_type":"incoming",
    "call_duration":6,
    "call_status":"answered",
    "source":{
      "type":"address_contact",
      "id":8203
    },
    "destination":{
      "type":"extension",
      "id":7048
    }
  },
  "timestamp":1507305512,
  "auth_token":"my-token"
}

In cases where the source and destination are recognised and stored in the phone system, such as the above example with an external address contact source and an extension destination, they will be presented as a hash with the object type and ID.

In the example below, unrecognised sources and destinations will be presented as a string.

CallProcessed - unrecognised destination

{
  "payload":{
    "event":"CallProcessed",
    "call_id":"3dc54a92-aaaf-11e7-b600-7ac8e42434d2",
    "call_cost":"0.01",
    "call_type":"outgoing",
    "call_duration":5,
    "call_status":"answered",
    "source":{
      "type":"extension",
      "id":7048
    },
    "destination":"01234567890"
  },
  "timestamp":1507305538,
  "auth_token":"hTUxUXj6Du7nhlUumr4SqSmyQ57i0y"
}

Fine-tune your preferences

There are a number of cookies we need to use in order for our website to work properly. These cannot be disabled.

However, you can disable non-essential cookies for the third-party services we use, to help us provide better customer support, measure the performance of this website and run more effective marketing campaigns.

We use Google Analytics to measure the performance of our website. We do not store any personal data and your IP address is anonymised.

Off
On

We use a live chat service called Natterly so we can privide support to you where available. Various cookies are stored so chats remain active when you change page.

Off
On

We use various tracking cookies to help us measure the performance of our marketing campaigns and show you content and promotions we think you’d be interested in.

Off
On
Allow all
Update your preferences

Hello there!

This website uses cookies in order to provide you with the most relevant information. Please accept cookies for the best experience.

For more details see our Privacy Policy.

I’m OK with that
Cookie preferences