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

Retrieve information for a call

A code snippet that shows how to retrieve information for a call. The call to retrieve information for is identified via a UUID.

Example

Replace the following variables in the example code:

Key Description
UUID The UUID for the call for which information is being requested.
  • cURL
  • Node.js
  • Java
  • .NET
  • PHP
  • Python
  • Ruby

    • Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Generate your JWT

    Execute the following command at your terminal prompt to create the JWT for authentication:

    export JWT=$(nexmo jwt:generate $PATH_TO_PRIVATE_KEY application_id=$NEXMO_APPLICATION_ID)

    Write the code

    Add the following to retrieve-info-for-a-call.sh:

    Copy to Clipboard 
    curl "https://api.nexmo.com/v1/calls/"$UUID \
  -H "Authorization: Bearer "$JWT \

    View full source

    Run your code

    Save this file to your machine and run it: 

    bash retrieve-info-for-a-call.sh

    Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Install dependencies

    npm install nexmo
    Initialize your dependencies

    Create a file named get-call.js and add the following code:

    Copy to Clipboard 
    const Nexmo = require('nexmo');

const nexmo = new Nexmo({
  apiKey: NEXMO_API_KEY,
  apiSecret: NEXMO_API_SECRET,
  applicationId: NEXMO_APPLICATION_ID,
  privateKey: NEXMO_PRIVATE_KEY
}, {debug: true});

    View full source

    Write the code

    Add the following to get-call.js:

    Copy to Clipboard 
    nexmo.calls.get(CALL_UUID, (err, res) => {
  if(err) { console.error(err); }
  else {
      console.log(res);
  }
});

    View full source

    Run your code

    Save this file to your machine and run it: 

    node get-call.js

    Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Install dependencies

    Add the following to build.gradle:

    compile 'com.nexmo:client:5.1.0'
    Initialize your dependencies

    Create a class named RetrieveCallInfo and add the following code to the main method:

    Copy to Clipboard 
    NexmoClient client = NexmoClient.builder()
        .applicationId(NEXMO_APPLICATION_ID)
        .privateKeyPath(NEXMO_PRIVATE_KEY_PATH)
        .build();

    View full source

    Write the code

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

    Copy to Clipboard 
    System.out.println(client.getVoiceClient().getCallDetails(UUID));

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

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

    Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Install dependencies

    Install-Package Nexmo.Csharp.Client
    Initialize your dependencies

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

    Copy to Clipboard 
    var client = new Client(creds: new Nexmo.Api.Request.Credentials
{
    ApiKey = "NEXMO_API_KEY",
    ApiSecret = "NEXMO_API_SECRET",
    ApplicationId = "NEXMO_APPLICATION_ID",
    ApplicationKey = "NEXMO_APPLICATION_PRIVATE_KEY"
});

    View full source

    Write the code

    Add the following to VoiceController.cs:

    Copy to Clipboard 
    var call = Client.Call.Get(UUID);


ViewBag.calluuid = $"Uuid: {call.uuid}";
ViewBag.callconversation_uuid = $"Conversation uuid: {call.conversation_uuid}";
ViewBag.calltonumber = $"To: {call.to.number}";
ViewBag.callfromnumber = $"From: {call.from.number}";
ViewBag.callstatus = $"Status: {call.status}";
ViewBag.calldirection = $"Direction: {call.direction}";
ViewBag.callrate = $"Rate: {call.rate}";
ViewBag.callprice = $"Price: {call.price}";
ViewBag.callduration = $"Duration: {call.duration}";
ViewBag.callstart_time = $"Start time: {call.start_time}";
ViewBag.callend_time = $"End time: {call.end_time}";
ViewBag.callnetwork = $"Network: {call.network}";

    View full source

    Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Install dependencies

    composer require nexmo/client
    Initialize your dependencies

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

    Copy to Clipboard 
    $keypair = new \Nexmo\Client\Credentials\Keypair(
    file_get_contents(NEXMO_APPLICATION_PRIVATE_KEY_PATH),
    NEXMO_APPLICATION_ID
);

$client = new \Nexmo\Client($keypair);

    View full source

    Write the code

    Add the following to index.php:

    Copy to Clipboard 
    $call = $client->calls()->get(NEXMO_CALL_UUID);
echo json_encode($call).PHP_EOL;

    View full source

    Run your code

    Save this file to your machine and run it: 

    php index.php

    Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Install dependencies

    pip install nexmo
    Initialize your dependencies

    Create a file named retrieve-info-for-a-call.py and add the following code:

    Copy to Clipboard 
    import nexmo
from pprint import pprint

client = nexmo.Client(
    application_id=APPLICATION_ID,
    private_key=APPLICATION_PRIVATE_KEY_PATH,
)

    View full source

    Write the code

    Add the following to retrieve-info-for-a-call.py:

    Copy to Clipboard 
    # Note call can be made to current call or a completed call
response = client.get_call("NEXMO_CALL_UUID")
pprint(response)

    View full source

    Run your code

    Save this file to your machine and run it: 

    python3 retrieve-info-for-a-call.py

    Prerequisites

    Use your existing application

    To fetch information about a call, you must use the same NEXMO_APPLICATION_ID and private key that were used to create the call.

    Install dependencies

    gem install nexmo
    Initialize your dependencies

    Create a file named retrieve-info-for-a-call.rb and add the following code:

    Copy to Clipboard 
    client = Nexmo::Client.new(
  application_id: NEXMO_APPLICATION_ID,
  private_key: File.read(NEXMO_APPLICATION_PRIVATE_KEY_PATH)
)

    View full source

    Write the code

    Add the following to retrieve-info-for-a-call.rb:

    Copy to Clipboard 
    response = client.calls.get(NEXMO_CALL_UUID)

puts response.inspect

    View full source

    Run your code

    Save this file to your machine and run it: 

    ruby retrieve-info-for-a-call.rb

    Try it out

    You will need to:

    1. Set up a call and obtain the call UUID. You could use the 'connect an inbound call' code snippet to do this.
    2. Retrieve information for the call (this code snippet).