Join us in San Francisco on the 29/30th of October for two days of developer workshops and technical talks

Track NCCO progress

In this code snippet you see how to track how far through an NCCO a caller gets using the notify action

Example

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 "Track NCCO Progress Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
Install dependencies

npm install express

Write the code

Add the following to notify-a-call.js:

Copy to Clipboard
const app = require('express')()

const onInboundCall = (request, response) => {
  const ncco = [{
      "action": "talk",
      "text": "Thanks for calling the notification line"
    },
    {
      "action": "notify",
      "payload": {
        "foo": "bar"
      },
      "eventUrl": [
        `${request.protocol}://${request.get('host')}/webhooks/notification`
      ]
    },
    {
      "action": "talk",
      "text": "You will never hear me as the notification URL will return an NCCO "
    }
  ]

  response.json(ncco)
}

const onNotification = (request, response) => {
  const ncco = [{
    "action": "talk",
    "text": "Your notification has been received, loud and clear"
  }]

  response.json(ncco)
}

app
  .get('/webhooks/answer', onInboundCall)
  .post('/webhooks/notification', onNotification)

app.listen(3000)

View full source

Run your code

Save this file to your machine and run it:

node notify-a-call.js

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 "Track NCCO Progress 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.1.0'
compile 'com.sparkjava:spark-core:2.7.2'

Write the code

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

Copy to Clipboard
    port(3000);

    /*
     * Answer Route
     */
    get("/webhooks/answer", (req, res) -> {
        String notifyUrl = String.format("%s://%s/webhooks/notification", req.scheme(), req.host());

        TalkAction intro = TalkAction.builder("Thanks for calling the notification line.")
                .build();

        Map<String, String> payload = new HashMap<>();
        payload.put("foo", "bar");

        NotifyAction notify = NotifyAction.builder(payload)
                .eventUrl(notifyUrl)
                .build();

        TalkAction unheard = TalkAction.builder("You will never hear me as the notification URL will return an NCCO")
                .build();

        res.type("application/json");
        return new Ncco(intro, notify, unheard).toJson();
    });

    /*
     * Notification Route
     */
    post("/webhooks/notification", (req, res) -> {
        res.type("application/json");
        return new Ncco(
                TalkAction.builder("Your notification has been received, loud and clear.")
                        .build()
        ).toJson();
    });
}

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 TrackNccoProgress:

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

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 "Track NCCO Progress Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
Install dependencies

composer require nexmo/client
Initialize your dependencies

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

Copy to Clipboard
use \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;

require 'vendor/autoload.php';

$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) {
    $params = $request->getQueryParams();
    $uri = $request->getUri();
    $ncco = [
        [
            'action' => 'talk',
            'text' => 'Thanks for calling the notification line'
        ],
        [
            'action' => 'notify',
            'payload' => ['foo' => 'bar'],
            'eventUrl' => [
                $uri->getScheme().'://'.$uri->getHost().':'.$uri->getPort().'/webhooks/notification'
            ]
        ],
        [
            'action' => 'talk',
            'text' => 'You will never hear me as the notification URL will return an NCCO'
        ]
    ];

    return $response->withJson($ncco);
});

// The notification can be sent via GET or POST, depending on your eventMethod
$app->map(['GET', 'POST'], '/webhooks/notification', function(Request $request, Response $response) {
    $params = $request->getParsedBody();

    // Fall back to query parameters if needed
    if (!count($params)){
        $params = $request->getQueryParams();
    }

    error_log(print_r($params, true));

    return $response->withJson([
        [
            'action' => 'talk',
            'text' => 'Your notification has been received, loud and clear'
        ]
    ]);
});

$app->map(['GET', 'POST'], '/webhooks/event', function (Request $request, Response $response) {
    $params = $request->getParsedBody();

    // Fall back to query parameters if needed
    if (!count($params)){
        $params = $request->getQueryParams();
    }

    error_log(print_r($params, true));
    return $response->withStatus(204);
});

$app->run();

View full source

Run your code

Save this file to your machine and run it:

php index.php

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 "Track NCCO Progress Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
Install dependencies

gem install sinatra sinatra-contrib rack-contrib
Initialize your dependencies

Create a file named track-ncco-progress.rb and add the following code:

Copy to Clipboard
use Rack::PostBodyContentTypeParser

before do
  content_type :json
end

View full source

Write the code

Add the following to track-ncco-progress.rb:

Copy to Clipboard
route :get, :post, '/webhooks/answer' do
  [
    {
      'action' => 'talk',
      'text' => 'Thanks for calling the notification line'
    },
    {
      'action' => 'notify',
      'payload' => {'foo' => 'bar'},
      'eventUrl' => ["#{request.base_url}/webhooks/notification"]
    },
    {
      'action' => 'talk',
      'text' => 'You will never hear me as the notification URL will return an NCCO'
    }
  ].to_json
end

route :get, :post, '/webhooks/notification' do
  puts params
  [
    {
      'action' => 'talk',
      'text' => 'Your notification has been received, loud and clear'
    }
  ].to_json
end

route :get, :post, '/webhooks/event' do
  puts params
  halt 204
end

set :port, 3000

View full source

Run your code

Save this file to your machine and run it:

ruby track-ncco-progress.rb

Try it out

When you call your Nexmo Number you will hear a text-to-speech message and receive a request to your notification URL