Application API Reference

<?php

$base_url = 'https://api.nexmo.com' ;
$version = '/v1';
$action = '/applications/?';

//Create an Application for Voice API.
$url = $base_url . $version . $action . http_build_query([
    'api_key' =>  'API_KEY',
    'api_secret' => 'API_SECRET',
    'name' => 'MyFirstApplication',
    'type' => 'voice',
    'answer_url' => 'https://nexmo-community.github.io/ncco-examples/conference.json',
    'event_url' => 'https://example.com/call_status'
]);
//In this example, answer_url points to a static NCCO that creates a Conference
//

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Content-Length: 0" ));
curl_setopt($ch, CURLOPT_HEADER, 1);
$response = curl_exec($ch);

$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);

if (strpos($header, '201')){
    $application = json_decode($body, true);
    if (! isset ($application['type'])){
        echo("Application " . $application['name']
                . " has an ID of:" . $application['id'] . "\n" ) ;
        echo("  Use the links to navigate. For example: "
            . $base_url
            . $application['_links']['self']['href'] . "\n"  );
    }else {
        echo ( "Error: " . $application['type']
            . " because of " . $application['error_title'] . "\n" );
    }
    foreach($application['voice']['webhooks'] as $webhook)
        echo ( "  " . $webhook['endpoint_type'] . " is " . $webhook['endpoint'] . "\n"  );

    echo("  Stock your public and private keys somewhere secure.\n" ) ;
    echo("  You use them to connect to Nexmo endpoints. They are:\n" ) ;
    echo("  " . $application['keys']['public_key'] );
    echo("  " . $application['keys']['private_key'] );
}
else {
    $error = json_decode($body, true);
    echo("Your request failed because:\n");
    echo("  " . $error['type'] . "  " . $error['error_title']   );
}

import requests

url = 'https://api.nexmo.com/v1/applications'
data = {
        'api_key': 'API_KEY',
        'api_secret': 'API_SECRET',
        'name' : 'MyFirstApplication',
        'type' : 'voice',
        'answer_url' : 'https://nexmo-community.github.io/ncco-examples/conference.json',
        'event_url' : 'https://example.com/call_status'
}
#In this example, answer_url points to a static NCCO that creates a Conference.

resp = requests.post(url, params=data)

try:
    if resp.status_code == 201:
        application = resp.json()
        print "Application " + application['name'] + " has an ID of: " + application['id']
        for webhook in application['voice']['webhooks']:
                print "  " + webhook['endpoint_type'] + " is " + webhook['endpoint']
        print "  You use your private key to connect to Nexmo endpoints:"
        print "  " + application['keys']['private_key']
    else:
        print "HTTP Response: " + resp.status_code
        print resp.json()

except requests.exceptions.HTTPError as e:
    print e

require 'nexmo'

nexmo_client = Nexmo::Client.new(api_key: 'API_KEY', api_secret: 'API_SECRET')

id = 'aaaaaaaa-bbbb-cccc-dddd-0123456789ab'

application = nexmo_client.applications.create(id, {
  name: 'Example Application',
  type: 'voice',
  answer_url: 'https://example.com/answer',
  event_url: 'https://example.com/event',
})

application.id
#=> "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"

<?php

$base_url = 'https://api.nexmo.com' ;
$version = '/v1';
$action = '/applications/?';

# Create an Application for Messages & Dispatch API
$url = $base_url . $version . $action . http_build_query([
    'api_key' =>  'API_KEY',
    'api_secret' => 'API_SECRET',
    'name' => 'MyFirstApplication',
    'type' => 'messages',
    'status_url' => 'https://example.com/status',
    'inbound_url' => 'https://example.com/inbound'
]);



$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Content-Length: 0" ));
curl_setopt($ch, CURLOPT_HEADER, 1);
$response = curl_exec($ch);

$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);

if (strpos($header, '201')){
    $application = json_decode($body, true);
    if (! isset ($application['type'])){
        echo("Application " . $application['name']
                . " has an ID of:" . $application['id'] . "\n" ) ;
        echo("  Use the links to navigate. For example: "
            . $base_url
            . $application['_links']['self']['href'] . "\n"  );
    }else {
        echo ( "Error: " . $application['type']
            . " because of " . $application['error_title'] . "\n" );
    }
    foreach($application['voice']['webhooks'] as $webhook)
        echo ( "  " . $webhook['endpoint_type'] . " is " . $webhook['endpoint'] . "\n"  );

    echo("  Stock your public and private keys somewhere secure.\n" ) ;
    echo("  You use them to connect to Nexmo endpoints. They are:\n" ) ;
    echo("  " . $application['keys']['public_key'] );
    echo("  " . $application['keys']['private_key'] );
}
else {
    $error = json_decode($body, true);
    echo("Your request failed because:\n");
    echo("  " . $error['type'] . "  " . $error['error_title']   );
}

import requests

url = 'https://api.nexmo.com/v1/applications'
data = {
        'api_key': 'API_KEY',
        'api_secret': 'API_SECRET',
        'name' : 'MyFirstApplication',
        'type' : 'voice',
        'status_url' : 'https://example.com/status',
        'inbound_url' : 'https://example.com/inbound'
}

resp = requests.post(url, params=data)

try:
    if resp.status_code == 201:
        application = resp.json()
        print "Application " + application['name'] + " has an ID of: " + application['id']
        for webhook in application['voice']['webhooks']:
                print "  " + webhook['endpoint_type'] + " is " + webhook['endpoint']
        print "  You use your private key to connect to Nexmo endpoints:"
        print "  " + application['keys']['private_key']
    else:
        print "HTTP Response: " + resp.status_code
        print resp.json()

except requests.exceptions.HTTPError as e:
    print e

require 'nexmo'

nexmo_client = Nexmo::Client.new(api_key: 'API_KEY', api_secret: 'API_SECRET')

id = 'aaaaaaaa-bbbb-cccc-dddd-0123456789ab'

application = nexmo_client.applications.create(id, {
  name: 'Example Application',
  type: 'messages',
  status_url: 'https://example.com/status',
  inbound_url: 'https://example.com/inbound',
})

application.id
#=> "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"

<?php

$base_url = 'https://api.nexmo.com' ;
$version = '/v1';
$action = '/applications/?';

$url = $base_url . $version . $action . http_build_query([
    'api_key' => 'API_KEY',
    'api_secret' => 'API_SECRET'
]);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Accept: application/json'));
curl_setopt($ch, CURLOPT_HEADER, 1);
$response = curl_exec($ch);

$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);

if (strpos($header, '200')){
    $decoded_response = json_decode($body, true);
    echo("You have " . $decoded_response['count'] . " applications\n");
    echo("Page " . $decoded_response['page_index']
        . " lists " . $decoded_response['page_size'] . " applications\n");
    echo("Use the links to navigate. For example: "
        . $base_url .  $decoded_response['_links']['last']['href'] . "\n"  );
    $applications = $decoded_response['_embedded']['applications'] ;

    foreach ( $applications as $application ) {
        echo "  Application ID is:" . $application['id'] . "\n"  ;
        foreach($application['voice']['webhooks'] as $webhook)
            echo ( "    " . $webhook['endpoint_type'] . " is " . $webhook['endpoint'] . "\n"  );
    }
}
else {
    $error = json_decode($body, true);
    echo("Your request failed because:\n");
    echo("  " . $error['type'] . "  " . $error['error_title']   );
}

import requests

url = 'https://api.nexmo.com/v1/applications'
data = {
    'api_key': 'API_KEY',
    'api_secret': 'API_SECRET'
}

resp = requests.get(url, params=data)
try:
    if resp.status_code == 200:
        resp_data = resp.json()
        print "You have " + str(resp_data['count']) + " applications"
        print "Page " + str(resp_data['page_index']) + \
            " lists " + str(resp_data['page_size']) + " applications"
        print "Use the links to navigate. For example: https://api.nexmo.com" \
            +  resp_data['_links']['last']['href']
        for application in resp_data['_embedded']['applications'] :
            print "Application " + application['name'] + \
                " has an ID of: " + application['id']
            for webhook in application['voice']['webhooks'] :
                print "  " + webhook['endpoint_type'] + " is " + webhook['endpoint']
    else:
        print "Your request failed because:"
        print resp.json()
except requests.exceptions.HTTPError as e:
    print e

require 'nexmo'

nexmo_client = Nexmo::Client.new(api_key: 'API_KEY', api_secret: 'API_SECRET')

applications = nexmo_client.applications.list

applications.count
#=> 2

applications._embedded.applications[0].id
#=> "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"