Receive an inbound call

In this code snippet you see how to receive an inbound call.

Example

Prerequisites

npm install express

Write the code

Add the following to receive-an-inbound-call.js:

const Express = require('express');

const app = new Express();

const onInboundCall = (request, response) => {
  const from = request.query.from;
  const fromSplitIntoCharacters = from.split('').join(' ');

  const ncco = [
    {
      action: 'talk',
      text: `Thank you for calling from ${fromSplitIntoCharacters}`,
    },
  ];

  response.json(ncco);
};

app.get('/webhooks/answer', onInboundCall);

app.listen(port, () => {
  console.log(`Example app listening on port ${port}`);
});

View full source

Run your code

Save this file to your machine and run it:

node receive-an-inbound-call.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'
implementation 'io.ktor:ktor-server-netty'
implementation 'io.ktor:ktor-serialization-jackson'

Write the code

Add the following to the main method of the ReceiveInboundCall file:

embeddedServer(Netty, port = 8000) {
    routing {
        get("/webhooks/answer") {
            val from = call.request.queryParameters["from"]?.replace("", "")
            call.response.header("Content-Type", "application/json")
            call.respond(
                Ncco(
                    talkAction("Thank you for calling from $from")
                ).toJson()
            )
        }
    }
}.start(wait = true)

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.voice with the package containing ReceiveInboundCall:

gradle run -Pmain=com.vonage.quickstart.kt.voice.ReceiveInboundCall

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'
implementation 'com.sparkjava:spark-core:2.9.4'

Write the code

Add the following to the main method of the InboundCall file:

/*
 * Route to answer incoming call.
 */
Route answerRoute = (req, res) -> {
    String from = req.queryParams("from").replace("", " ");
    TalkAction message = TalkAction
            .builder(String.format("Thank you for calling from %s", from))
            .build();

    res.type("application/json");

    return new Ncco(message).toJson();
};

/*
 * Route to print out call event info.
 */
Route eventRoute = (req, res) -> {
    System.out.println(req.body());
    return "";
};

Spark.port(3000);
Spark.get("/webhooks/answer", answerRoute);
Spark.post("/webhooks/events", eventRoute);

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.voice with the package containing InboundCall:

gradle run -Pmain=com.vonage.quickstart.voice.InboundCall

Prerequisites

Install-Package Vonage

Write the code

Add the following to ReceiveInboundCallController.cs:

[HttpGet("webhooks/answer")]
public string Answer()
{            
    var talkAction = new TalkAction
    { 
        Text = "Thank you for calling from " +
        $"{string.Join(" ", Request.Query["from"].ToString().ToCharArray())}"
    };
    var ncco = new Ncco(talkAction);
    return ncco.ToString();
}

View full source

Prerequisites

composer require slim/slim:^3.8 vonage/client

Write the code

Add the following to index.php:

require 'vendor/autoload.php';

$app = new \Slim\App();

$app->get('/webhooks/answer', function (Request $request, Response $response) {
    /** @var \Vonage\Voice\Webhook\Answer $call */
    $call = \Vonage\Voice\Webhook\Factory::createFromRequest($request);
    $fromSplitIntoCharacters = implode(" ", str_split($call->getFrom()));

    $ncco = new \Vonage\Voice\NCCO\NCCO();
    $ncco->addAction(
        new \Vonage\Voice\NCCO\Action\Talk('Thank you for calling from ' . $fromSplitIntoCharacters)
    );

    return new JsonResponse($ncco);
});

$app->run();

View full source

Run your code

Save this file to your machine and run it:

php -S localhost:3000 -t .

Prerequisites

pip install vonage python-dotenv fastapi[standard]

Write the code

Add the following to receive-an-inbound-call.py:

from fastapi import FastAPI, Query
from vonage_voice import Talk

app = FastAPI()


@app.get('/webhooks/answer')
async def answer_call(from_: str = Query(..., alias='from')):
    from_ = '-'.join(from_)
    return [
        Talk(text=f'Thank you for calling from {from_}').model_dump(
            by_alias=True, exclude_none=True
        )
    ]

View full source

Run your code

Save this file to your machine and run it:

fastapi dev voice/receive-an-inbound-call.py

Prerequisites

gem install sinatra sinatra-contrib

Write the code

Add the following to inbound_tts_call.rb:

require 'sinatra'
require 'sinatra/multi_route'
require 'json'

helpers do
  def parsed_body
    JSON.parse(request.body.read)
  end
end

before do
  content_type :json
end

route :get, :post, '/webhooks/answer' do
  from = params['from'] || parsed_body['from']
  from_split_into_characters = from.split('').join(' ')

  [{
    action: 'talk',
    text: "Thank you for calling from #{from_split_into_characters}"
  }].to_json
end

set :port, 3000

View full source

Run your code

Save this file to your machine and run it:

ruby inbound_tts_call.rb

Try it out

When you call your Vonage Number you will hear a text-to-speech message.

Further Reading

  • Interactive Voice Response (IVR) - Build an automated phone system for users to input information with the keypad and hear a spoken response.
  • Voice Bot with Google Dialogflow - This guide will help you to start with an example Dialogflow bot and interact with it from phone calls using provided sample reference codes using Vonage Voice API.
  • Masked Calling - Enable users to call each other, keeping their real numbers private.
  • Conference Calling - This guide explains the two concepts Vonage associates with a call, a leg and a conversation.
  • Call Tracking - Keep track of which campaigns are working well by using different numbers for each one and tracking the incoming calls. This guide shows you how to handle incoming calls, connect them to another number, and track the phone numbers that called each of your Vonage numbers.