Qualify leads using AMD and IVR with Node.js

index.mjs

This code is used to start a lightweight web server that qualifies leads.

import fetch from 'node-fetch'
import express from 'express'
import ngrok from 'ngrok'

// Find everything you need at dashboard.sinch.com/voice/apps
const APPLICATION_KEY = 'YOUR_application_key';
const APPLICATION_SECRET = 'YOUR_application_secret';
const OUTGOING_NUMBER = 'YOUR_sinch_number'; //The Sinch number you'll be using to make the callout
const SIP_URI = 'YOUR_sip_endpoint'; //The number you want to connect the call to when a lead is qualified

const PORT = 3000;

const app = express();
app.use(express.json());

app.post('/callout', (req, res) => {
  makeCallout(APPLICATION_KEY, APPLICATION_SECRET, req.query.number.toString());
  res.json();
});

app.post('/answer', async (req, res) => {
  console.log(req.body);
  let response = handleEventType(req.body);
  console.log(response);
  res.json(response);
});

function handleEventType(requestBody){
  switch (requestBody.event){
    case 'ace':
      return handleAmdStatus(requestBody.amd.status);
    case 'pie':
      return handleMenuResult(requestBody.menuResult.value);
  }
}

function handleMenuResult(menuResult){
  switch (menuResult){
    case 'sip':
      return sipResponse();
    case 'non-sip':
      return nonSipResponse();
    default:
      return defaultResponse();
  }
}

function sipResponse(){
  return {
    instructions: [
      {
        name: 'say',
        text: 'Thank you for choosing to speak to one of our sales reps! Since you have a sip infrastructure, you will now be connected.'
      }
    ],
    action: {
      name: 'connectSip',
      destination: {
        endpoint: SIP_URI
      },
      cli: TO_NUMBER,
      transport: 'tls'
    }
  };
  
}

function nonSipResponse(){
  return {
    instructions: [
      {
        name: 'say',
        text: 'Thank you for choosing to speak to one of our sales reps! If this were in production, at this point you would be connected to a sales rep on your sip network. Since you do not, you have now completed this tutorial. We hope you had fun and learned something new. Be sure to keep visiting developers.sinch.com for more great tutorials.'
      }
    ],
    action: {
      name: 'hangup',
    }
  };
}

function defaultResponse(){
  return {
    instructions: [
      {
        name: 'say',
        text: 'Thanks for trying our tutorial! Have a great day.'
      }
    ],
    action: {
      name: 'hangup'
    }
  };
}

function handleAmdStatus(amdStatus){
  switch (amdStatus){
    case 'human':
      return humanResponse();
    case 'machine':
      return machineResponse();
  }
};

function humanResponse(){
  return {
    action: {
      name: 'runMenu',
      barge: false,
      menus: [
        { id: 'main',
          mainPrompt: '#tts[Hi, you awesome person! Press 1 if you have performed this tutorial using a sip infrastructure. Press 2 if you have not used a sip infrastructure. Press any other digit to end this call.]',
          repeatPrompt: '#tts[Again, simply press 1 if you have used sip, press 2 if you have not, or press any other digit to end this call.]',
          repeats: 2,
          options: [
            {
              dtmf: 1,
              action: 'return(sip)'
            },
            {
              dtmf: 2,
              action: 'return(non-sip)'
            }
          ]
        }
      ]
      }
  };
}

function machineResponse(){
  return {
    instructions: [
      {
        name: 'say',
        text: 'Hi you awesome person! We tried to reach you to speak with you about our awesome products. We will try again later! Bye',
      },
    ],
    action: {
      name: 'hangup',
    }
  };
}

app.listen(PORT, async () => {
  const ngrokUrl = await ngrok.connect(PORT);
  console.log(`Node.js local server is publicly-accessible at ${ngrokUrl}/answer`);
  await updateUrl(ngrokUrl + '/answer');
  console.log(`Listening at http://localhost:` + PORT);
});

async function updateUrl(ngrokUrl) {
  
  const resp = await fetch(
    `https://callingapi.sinch.com/v1/configuration/callbacks/applications/${APPLICATION_KEY}`,
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        Authorization: 'Basic ' + Buffer.from(`${APPLICATION_KEY}:${APPLICATION_SECRET}`).toString('base64')
      },
      body: JSON.stringify({
        url:
         {  
          primary: ngrokUrl
         }
      })
    }
  );
  console.log("Your callback URL has been updated on your dashboard.")
}

async function makeCallout(applicationKey, applicationSecret, number) {
    
    const calloutBody = {
        method: 'customCallout',
        customCallout: {
            ice: "{\"action\": {\"name\": \"connectPstn\", \"number\": \"" + number + "\", \"cli\": \"" + OUTGOING_NUMBER + "\", \"amd\": {\"enabled\": true }, \"locale\": \"en-US\" }}",
            enableAce: true,
            enableDice: true
        }
    };
    
    const resp = await fetch(
        `https://calling.api.sinch.com/calling/v1/callouts`,
        {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                Authorization: 'Basic ' + Buffer.from(`${applicationKey}:${applicationSecret}`).toString('base64')
            },
            body: JSON.stringify(calloutBody) 
        }
    );
    const data = await resp.json();
    console.log(data);
}