/
Voice webhook v1 format

Voice webhook v1 format

We are using a new format see our main page.

 

Call completed Legacy format

The voice service supports the use of webhook messages. When a voice call has been completed the result will be reported to your webhook URL. We can authenticate to your webhook with basic access authentication.

Contact us to configure your webhook URL.

Format

The webhook request is a standard HTTP POST request with a JSON body, which is formatted as follows.

Field

 

Format

Field

 

Format

id
string

UUID, identifying the call uniquely

 

attributes
array

Contains the 'reference' used at import (identification_identifier).

 

direction
string

Call direction

ENUM DIRECTION

outbound inbound

status
string

The call status

ENUM STATUS

ringing active finished no answer busy rejected invalid number failed

localNumber
string

 

E164

remoteNumber
string

 

E164

events
array

Array of events during the call,
contains the following fields

nodeId: string, node identifier nodeType: string, ENUM NODETYPE order: int, event order type: string, ENUM EVENTTYPE data: array, data that is specific to the node type and event type time: string, RFC3339

Empty when the call is not answered.

 

NODETYPE: AddResult CheckCallAttempt CheckCounter CheckGenderBirthday CheckVariable DTMF DTMFString Forward Hangup IsCallOutbound IsRemoteMobile IsRemoteVoiceMail IsTimeInInterval Sound WaitForSilence EVENTTYPE: NodeStart NodeUpdate NodeResult

createdOn
string

 

RFC3339
2019-10-12T07:20:50.52Z

updatedOn
string

 

RFC3339
2019-10-12T07:20:50.52Z

answeredOn
string

Empty if the call has not been answered.

RFC3339 or empty
2019-10-12T07:20:50.52Z

 

Example message for an outbound call

{ "id": "e7813601-21ae-465c-bd97-96367bebd0ca", "attributes": { "origin": "annabel", "customer": "6500", "script": "6512", "job": "eb44f88bd968749a620765a382ef3c75c20a657c37499392d59958c5dd944652-06512", "reference": "API reference / identification_identifier" }, "direction": "outbound", "status": "finished", "localNumber": "31513703800", "remoteNumber": "31640754459", "events": [{ "nodeId": "vm_beep", "nodeType": "Sound", "order": 1, "type": "NodeStart", "data": [], "time": "2020-05-06T08:42:55+00:00" }, { "nodeId": "vm_beep", "nodeType": "Sound", "order": 2, "type": "NodeResult", "data": [], "time": "2020-05-06T08:42:59+00:00" }, { "nodeId": "vm_wait_for_silence", "nodeType": "WaitForSilence", "order": 3, "type": "NodeStart", "data": [], "time": "2020-05-06T08:42:59+00:00" }, { "nodeId": "vm_is_vm", "nodeType": "IsRemoteVoiceMail", "order": 5, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:00+00:00" }, { "nodeId": "text10", "nodeType": "Sound", "order": 7, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:00+00:00" }, { "nodeId": "text10", "nodeType": "Sound", "order": 8, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:05+00:00" }, { "nodeId": "filter", "nodeType": "CheckGenderBirthday", "order": 9, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:05+00:00" }, { "nodeId": "filter", "nodeType": "CheckGenderBirthday", "order": 10, "type": "NodeResult", "data": { "gender": "M", "age": 2020, "outcome": "man" }, "time": "2020-05-06T08:43:05+00:00" }, { "nodeId": "text11m", "nodeType": "Sound", "order": 11, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:05+00:00" }, { "nodeId": "text11m", "nodeType": "Sound", "order": 12, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:08+00:00" }, { "nodeId": "name", "nodeType": "Sound", "order": 13, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:09+00:00" }, { "nodeId": "name", "nodeType": "Sound", "order": 14, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:10+00:00" }, { "nodeId": "success", "nodeType": "AddResult", "order": 15, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:11+00:00" }, { "nodeId": "success", "nodeType": "AddResult", "order": 16, "type": "NodeResult", "data": { "result": "success-ok" }, "time": "2020-05-06T08:43:11+00:00" }, { "nodeId": "collect_id", "nodeType": "Sound", "order": 17, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:11+00:00" }, { "nodeId": "collect_id", "nodeType": "Sound", "order": 18, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:16+00:00" }, { "nodeId": "text22", "nodeType": "Sound", "order": 19, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:17+00:00" }, { "nodeId": "text22", "nodeType": "Sound", "order": 20, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:23+00:00" }, { "nodeId": "amount", "nodeType": "Sound", "order": 21, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:24+00:00" }, { "nodeId": "amount", "nodeType": "Sound", "order": 22, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:28+00:00" }, { "nodeId": "text30", "nodeType": "Sound", "order": 23, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:29+00:00" }, { "nodeId": "text30", "nodeType": "Sound", "order": 24, "type": "NodeResult", "data": [], "time": "2020-05-06T08:43:45+00:00" }, { "nodeId": "text31", "nodeType": "Sound", "order": 25, "type": "NodeStart", "data": [], "time": "2020-05-06T08:43:46+00:00" }, { "nodeId": "text31", "nodeType": "Sound", "order": 26, "type": "NodeResult", "data": [], "time": "2020-05-06T08:44:07+00:00" }, { "nodeId": "businesshours", "nodeType": "IsTimeInInterval", "order": 27, "type": "NodeStart", "data": [], "time": "2020-05-06T08:44:07+00:00" }, { "nodeId": "businesshours_forward_switch", "nodeType": "CheckVariable", "order": 29, "type": "NodeStart", "data": [], "time": "2020-05-06T08:44:07+00:00" }, { "nodeId": "text40", "nodeType": "DTMF", "order": 31, "type": "NodeStart", "data": [], "time": "2020-05-06T08:44:07+00:00" }, { "nodeId": "text40", "nodeType": "DTMF", "order": 32, "type": "NodeResult", "data": { "input": [], "outcome": "timeout" }, "time": "2020-05-06T08:44:20+00:00" }, { "nodeId": "text43", "nodeType": "Sound", "order": 33, "type": "NodeStart", "data": [], "time": "2020-05-06T08:44:20+00:00" }, { "nodeId": "text43", "nodeType": "Sound", "order": 34, "type": "NodeResult", "data": [], "time": "2020-05-06T08:44:32+00:00" }, { "nodeId": "text44", "nodeType": "Sound", "order": 35, "type": "NodeStart", "data": [], "time": "2020-05-06T08:44:32+00:00" }, { "nodeId": "text44", "nodeType": "Sound", "order": 36, "type": "NodeResult", "data": [], "time": "2020-05-06T08:44:36+00:00" }, { "nodeId": "text45", "nodeType": "DTMF", "order": 37, "type": "NodeStart", "data": [], "time": "2020-05-06T08:44:37+00:00" }, { "nodeId": "text45", "nodeType": "DTMF", "order": 38, "type": "NodeResult", "data": { "input": [], "outcome": "timeout" }, "time": "2020-05-06T08:44:49+00:00" }, { "nodeId": "exit", "nodeType": "Hangup", "order": 40, "type": "NodeResult", "data": [], "time": "2020-05-06T08:44:49+00:00" }], "createdOn": "2020-05-06T08:42:48+00:00", "updatedOn": "2020-05-06T08:44:49+00:00", "answeredOn": "2020-05-06T08:42:54+00:00" }