Voice Applications

IMPORTANT!

If you hadn't yet read the intro part of this section, please click here to read it first.

As explained in the intro, there are two types of Voice Applications: Attached and Detached.

Module Usage

Setup Overview

The usage of both web hooks is identical and is explained in the Getting Started guide.

Webhook Input Parameters

TL;DR Reference

While the complete JSON object input includes multiple parameters, the following table includes that most common parameters used. Some of the parameters are returned by action - which means, they are only made available, when the webhook is invoked as a result of an action defined in a module.

Parameter	Type	Description	Available
Session	String	A unique session identified	Always
CallStartTime	String	When was the call started?	Always
Domain	String	The Cloudonix domain name	Always
To	String	The voice call destination	Always
From	String	The voice call origin	Always
CallDirection	String	Inbound or Outbound	Always
CallStatus	String	The voice call status	Always
SessionStatus	String	Session Status as currently maintained in Cloudonix	Always
SpeechResult	String	A string result from a GATHER module (voice)	on action
Digits	String	A string result from a GATHER module (dtmf)	on action
profile	Collection	An ongoing session profile collection, similar to a browser cookie.	Always
query	Collection	A collection of query parameters provided to the endpoint	Always
headers	Collection	A collection of HTTP Headers provided to the endpoint	Always

Input Reference

When invoked, a JSON object will be made available to Make.com, that looks like this:

Sample Voice Application Request Parameters

[
  {
    "To": "99999999",
    "From": "88888888",
    "body": {
      "ApiVersion": "1",
      "CallStatus": "in-progress",
      "From": "88888888",
      "CallSid": "697f1777517e4007b13f3ee1939b626c",
      "To": "99999999",
      "SessionData": {
        "id": 9804683,
        "domainId": 755,
        "destination": "99999999",
        "callerId": "88888888",
        "token": "697f1777517e4007b13f3ee1939b626c",
        "profile": {
          "callId": [
           "08def5cc3788c0841313026c19e88943@xx.xx.xx.xx:5060"
          ],
          "inbound-trunk-name": "fromPSTN-xx.xx.xx.xx",
          "inbound-trunk-id": 610
        },
        "callStartTime": 1716188977551,
        "status": "processing",
        "vappServer": "172.24.40.220",
        "ringing": false,
        "domainNameOrId": "xxxxxx.xxxxxx.com"
      },
      "Domain": "xxxxxx.xxxxxx.com",
      "Direction": "inbound",
      "AccountSid": "xxxxxxxx.xxxxxxxxx.xxxxxxxxx",
      "Session": "697f1777517e4007b13f3ee1939b626c"
    },
    "query": {},
    "Domain": "xxxxxx.xxxxxx.com",
    "CallSid": "697f1777517e4007b13f3ee1939b626c",
    "headers": {
      "connection": "upgrade",
      "host": "hook.eu1.make.com",
      "x-forwarded-for": "3.149.247.24, 172.70.126.63, hook.eu1.make.com",
      "x-forwarded-proto": "https",
      "x-real-ip": "172.70.126.63",
      "x-request-id": "605bcfd6afec4b1b8b70bdcb50c7b64b",
      "content-length": "702",
      "cdn-loop": "cloudflare",
      "cf-ipcountry": "US",
      "accept-encoding": "gzip, br",
      "cf-ray": "886a80972a492b1c-ORD",
      "cf-visitor": "{\"scheme\":\"https\"}",
      "user-agent": "APP.Core/5.3.471",
      "content-type": "application/json",
      "authorization": "Bearer xyxyxyxyxyxyxyxyxyxyxy",
      "x-cx-session": "697f1777517e4007b13f3ee1939b626c",
      "x-cx-apikey": "XI225xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "x-cx-from": "88888888",
      "x-cx-stageid": "697f1777517e4007b13f3ee1939b626c",
      "x-cx-domain": "xxxxxxxx.xxxxxxxx.com",
      "x-cx-to": "99999999",
      "x-cx-source": "BORDER",
      "cf-connecting-ip": "3.149.247.24"
    },
    "CallStatus": "in-progress",
    "SessionData": {
      "id": 9804683,
      "domainId": 755,
      "destination": "99999999",
      "callerId": "88888888",
      "token": "697f1777517e4007b13f3ee1939b626c",
      "profile": {
        "callId": [
          "08def5cc3788c0841313026c19e88943@xx.xx.xx.xx:5060"
        ],
        "inbound-trunk-name": "fromPSTN-xx.xx.xx.xx",
        "inbound-trunk-id": 610
      },
      "callStartTime": 1716188977551,
      "status": "processing",
      "vappServer": "172.24.40.220",
      "ringing": false,
      "domainNameOrId": "xxxxxx.xxxxxxx.com"
    },
    "CallDirection": "inbound",
    "CallStartTime": 1716188977551,
    "SessionStatus": "processing",
    "MakeScenarioURL": "https://hook.eu1.make.com/ml2u7j35hid88toh41diir5tnocmj9w7"
  }
]