Connect an inbound call

In this code snippet you see how to connect an inbound call to another person by making an outbound call.

Example

Replace the following variables in the example code:

Key	Description
`NEXMO_NUMBER`	This is your nexmo number used for CallerID to the recipient.
`YOUR_SECOND_NUMBER`	This is the number to be connected to e.g. 447700900002.

Prerequisites

Create an application

A Nexmo application contains the required configuration for your project. You can create an application using the Nexmo CLI (see below) or via the dashboard. To learn more about applications see our Nexmo concepts guide.

Install the CLI

npm install -g nexmo-cli

Create an application

Once you have the CLI installed you can use it to create a Nexmo application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID in the example below. It will also create private.key in the current directory which you will need in the Initialize your dependencies step

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

nexmo app:create "Connect Inbound Call Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Install dependencies

npm install express

Initialize your dependencies

Create a file named connect-an-inbound-call.js and add the following code:

Copy to Clipboard

const app = require('express')()

View full source

Write the code

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

Copy to Clipboard

const onInboundCall = (request, response) => {
  const ncco = [{
    action: 'connect',
    from: NEXMO_NUMBER,
    endpoint: [{
      type: 'phone',
      number: YOUR_SECOND_NUMBER
    }]
  }]

  response.json(ncco)
}

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

app.listen(3000)

View full source

Run your code

Save this file to your machine and run it:

node connect-an-inbound-call.js

Prerequisites

Create an application

Install the CLI

npm install -g nexmo-cli

Create an application

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

nexmo app:create "Connect Inbound Call Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Install dependencies

Add the following to `build.gradle`:

compile 'com.nexmo:client:5.2.1'
compile 'com.sparkjava:spark-core:2.7.2'

Write the code

Add the following to the main method of the ConnectInboundCall class:

Copy to Clipboard

/*
 * Route to answer incoming calls with an NCCO response.
 */
Route answerRoute = (req, res) -> {
    ConnectAction connect = ConnectAction.builder()
            .endpoint(PhoneEndpoint.builder(RECIPIENT_NUMBER).build())
            .from(NEXMO_NUMBER)
            .build();

    res.type("application/json");

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

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

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.nexmo.quickstart.voice with the package containing ConnectInboundCall:

gradle run -Pmain=com.nexmo.quickstart.voice.ConnectInboundCall

Prerequisites

Create an application

Install the CLI

npm install -g nexmo-cli

Create an application

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

nexmo app:create "Connect Inbound Call Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Install dependencies

Install-Package Nexmo.Csharp.Client

Import dependencies

Create a file named ConnectInboundCallController.cs and add the following code:

Copy to Clipboard

using Nexmo.Api.Voice.Nccos;
using Nexmo.Api.Voice.Nccos.Endpoints;

View full source

Write the code

Add the following to ConnectInboundCallController.cs:

Copy to Clipboard

[Route("webhooks/answer")]
public string Answer()
{
    var YOUR_SECOND_NUMBER = Environment.GetEnvironmentVariable("YOUR_SECOND_NUMBER") ?? "YOUR_SECOND_NUMBER";
    var NEXMO_NUMBER = Environment.GetEnvironmentVariable("NEXMO_NUMBER") ?? "NEXMO_NUMBER";

    var talkAction = new TalkAction()
    {
        Text = "Thank you for calling",
        VoiceName = "Kimberly"
    };

    var secondNumberEndpoint = new PhoneEndpoint() { Number=YOUR_SECOND_NUMBER};            
    var connectAction = new ConnectAction() { From=NEXMO_NUMBER, Endpoint= new[] { secondNumberEndpoint } };
    
    var ncco = new Ncco(talkAction,connectAction);
    return ncco.ToString();
}

View full source

Prerequisites

Create an application

Install the CLI

npm install -g nexmo-cli

Create an application

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

nexmo app:create "Connect Inbound Call Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Install dependencies

composer require slim/slim:^3.8 nexmo/client

Import dependencies

Create a file named index.php and add the following code:

Copy to Clipboard

use Dotenv\Dotenv;
use Laminas\Diactoros\Response\JsonResponse;
use \Psr\Http\Message\ResponseInterface as Response;
use \Psr\Http\Message\ServerRequestInterface as Request;

View full source

Initialize your dependencies

Add the following to index.php:

Copy to Clipboard

require 'vendor/autoload.php';

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();

define('YOUR_SECOND_NUMBER', getenv('YOUR_SECOND_NUMBER'));
define('NEXMO_NUMBER', getenv('NEXMO_NUMBER'));

$app = new \Slim\App();

View full source

Write the code

Add the following to index.php:

Copy to Clipboard

$app->get('/webhooks/answer', function (Request $request, Response $response) {
    $numberToConnect = new \Nexmo\Voice\Endpoint\Phone(YOUR_SECOND_NUMBER);

    $action = new \Nexmo\Voice\NCCO\Action\Connect($numberToConnect);
    $action->setFrom(NEXMO_NUMBER);

    $ncco = new \Nexmo\Voice\NCCO\NCCO();
    $ncco->addAction($action);

    return new JsonResponse($ncco->toArray());
});

$app->run();

View full source

Run your code

Save this file to your machine and run it:

php -S localhost:3000 -t .

Prerequisites

Create an application

Install the CLI

npm install -g nexmo-cli

Create an application

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

nexmo app:create "Connect Inbound Call Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Install dependencies

pip install 'flask>=1.0'

Initialize your dependencies

Create a file named connect-an-inbound-call.py and add the following code:

Copy to Clipboard

from flask import Flask, request, jsonify

app = Flask(__name__)

View full source

Write the code

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

Copy to Clipboard

@app.route("/webhooks/answer")
def answer_call():
    ncco = [
        {
            "action": "connect",
            "from": "NEXMO_NUMBER",
            "endpoint": [{
                "type": "phone",
                "number": "YOUR_SECOND_NUMBER"
            }]
        }
    ]
    return jsonify(ncco)

if __name__ == '__main__':
    app.run(port=3000)

View full source

Run your code

Save this file to your machine and run it:

python3 connect-an-inbound-call.py

Prerequisites

Create an application

Install the CLI

npm install -g nexmo-cli

Create an application

Nexmo needs to connect to your local machine to access your answer_url. We recommend using ngrok to do this. Make sure to change demo.ngrok.io in the examples below to your own ngrok URL.

nexmo app:create "Connect Inbound Call Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Install dependencies

gem install sinatra sinatra-contrib

Initialize your dependencies

Create a file named connect_an_inbound_call.rb and add the following code:

Copy to Clipboard

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

before do
  content_type :json
end

View full source

Write the code

Add the following to connect_an_inbound_call.rb:

Copy to Clipboard

route :get, :post, '/webhooks/answer' do
  [{
    action: 'connect',
    endpoint: [{
      type: 'phone',
      number: YOUR_SECOND_NUMBER
    }]
  }].to_json
end

set :port, 3000

View full source

Run your code

Save this file to your machine and run it:

ruby connect_an_inbound_call.rb

Try it out

You'll need to expose your server to the open internet. During development you can use a tool like Ngrok to do that.

When you call your Nexmo Number you will automatically be connected to the number you specified in place of YOUR_SECOND_NUMBER.