List Your Numbers

This page shows you how to list the numbers that you own programmatically.

You can also view your numbers online, using the developer dashboard or from the command line, using the Nexmo CLI.

Replace the following variables in the sample code with your own values:

Name Description
NEXMO_API_KEY Your Nexmo API key
NEXMO_API_SECRET Your Nexmo API secret
NUMBER_SEARCH_CRITERIA The filter criteria. For example, numbers containing 234.
NUMBER_SEARCH_PATTERN Where the NUMBER_SEARCH_CRITERIA should appear in the number:
  • 0 - At the beginning of the number
  • 1- Anywhere in the number
  • 2 - At the end of the number
  • cURL
  • Node.js
  • Java
  • .NET
  • PHP
  • Python
  • Ruby

    • Write the code

    Add the following to list-numbers.sh:

    Copy to Clipboard 
    curl "https://rest.nexmo.com/account/numbers?api_key=$NEXMO_API_KEY&api_secret=$NEXMO_API_SECRET&pattern=$NUMBER_SEARCH_CRITERIA&search_pattern=$NUMBER_SEARCH_PATTERN"

    View full source

    Run your code

    Save this file to your machine and run it: 

    sh list-numbers.sh

    Prerequisites

    Install dependencies

    npm install nexmo
    Initialize your dependencies

    Create a file named list.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
  },
  {
    debug: true
  }
)

    View full source

    Write the code

    Add the following to list.js:

    Copy to Clipboard 
    nexmo.number.get(
  {
    pattern: NUMBER_SEARCH_CRITERIA,
    search_pattern: NUMBER_SEARCH_PATTERN
  },
  (err, res) => {
    if (err) {
      console.error(err)
    } else {
      console.log(`Here are ${res.numbers.length} of your ${res.count} matching numbers:`)
      res.numbers.forEach((number) => {
        console.log(`Tel: ${number.msisdn} Cost: ${number.type}`)
      })
    }
  }
)

    View full source

    Run your code

    Save this file to your machine and run it: 

    node list.js

    Prerequisites

    Install dependencies

    Add the following to `build.gradle`:

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

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

    Copy to Clipboard 
    NexmoClient client = NexmoClient.builder()
        .apiKey(NEXMO_API_KEY)
        .apiSecret(NEXMO_API_SECRET)
        .build();

    View full source

    Write the code

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

    Copy to Clipboard 
    NumbersClient numbersClient = client.getNumbersClient();

ListNumbersResponse response = numbersClient.listNumbers(
        new ListNumbersFilter(1, 10, NUMBER_SEARCH_CRITERIA, NUMBER_SEARCH_PATTERN)
);

for (OwnedNumber number : response.getNumbers()) {
    System.out.println("Tel: " + number.getMsisdn());
    System.out.println("Type: " + number.getType());
    System.out.println("Country: " + number.getCountry());
}

    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.numbers with the package containing ListNumbers:

    gradle run -Pmain=com.nexmo.quickstart.numbers.ListNumbers

    Prerequisites

    Install dependencies

    Install-Package Nexmo.Csharp.Client
    Import dependencies

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

    Copy to Clipboard 
    using Nexmo.Api;
using Nexmo.Api.Numbers;
using Nexmo.Api.Request;

    View full source

    Initialize your dependencies

    Add the following to ListOwnedNumbers.cs:

    Copy to Clipboard 
    var credentials = Credentials.FromApiKeyAndSecret(NEXMO_API_KEY, NEXMO_API_SECRET);
var client = new NexmoClient(credentials);

    View full source

    Write the code

    Add the following to ListOwnedNumbers.cs:

    Copy to Clipboard 
    var request = new NumberSearchRequest() 
{ 
    SearchPattern = NUMBER_SEARCH_PATTERN, 
    Pattern = NUMBER_SEARCH_CRITERIA 
};

var response = client.NumbersClient.GetOwnedNumbers(request);

    View full source

    Prerequisites

    Install dependencies

    composer require nexmo/client
    Initialize your dependencies

    Create a file named list-owned.php and add the following code:

    Copy to Clipboard 
    $basic = new \Nexmo\Client\Credentials\Basic(NEXMO_API_KEY, NEXMO_API_SECRET);
$client = new \Nexmo\Client($basic);

    View full source

    Write the code

    Add the following to list-owned.php:

    Copy to Clipboard 
    $response = $client->numbers()->searchOwned(
    NUMBER_SEARCH_CRITERIA,
    [
        "search_pattern" => NUMBER_SEARCH_PATTERN,
    ]
);

echo count($response). " of your numbers match:\n";

foreach($response as $number) {
  echo "Tel: " . $number->getMsisdn() . " Type: " . $number->getType() . "\n";
}

    View full source

    Run your code

    Save this file to your machine and run it: 

    php list-owned.php

    Prerequisites

    Install dependencies

    pip install nexmo
    Initialize your dependencies

    Create a file named list.py and add the following code:

    Copy to Clipboard 
    import nexmo

client = nexmo.Client(key=NEXMO_API_KEY, secret=NEXMO_API_SECRET)

    View full source

    Write the code

    Add the following to list.py:

    Copy to Clipboard 
    responseData = client.get_account_numbers(
    {"pattern": NUMBER_SEARCH_CRITERIA, "search_pattern": NUMBER_SEARCH_PATTERN}
)

print(
    f'Here are {len(responseData["numbers"])} of the {responseData["count"]} matching numbers in your account:'
)

for number in responseData["numbers"]:
    print(f'Tel: {number["msisdn"]} Type: {number["type"]}')

    View full source

    Run your code

    Save this file to your machine and run it: 

    python list.py

    Prerequisites

    Install dependencies

    gem install nexmo
    Initialize your dependencies

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

    Copy to Clipboard 
    client = Nexmo::Client.new(
  api_key: NEXMO_API_KEY,
  api_secret: NEXMO_API_SECRET
)

    View full source

    Write the code

    Add the following to list.rb:

    Copy to Clipboard 
    begin
  response = client.numbers.list()

  puts "Here are #{response.numbers.length} of your #{response.count} matching numbers:"
  
  response.numbers.each do |number|
    puts "Tel: #{number.msisdn} Type: #{number.type}"
  end
rescue
  puts "Error listing your owned numbers"
end

    View full source

    Run your code

    Save this file to your machine and run it: 

    ruby list.rb

    See also