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 Vonage CLI.

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

Key	Description
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`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

Write the code

Add the following to list-numbers.sh:

curl \
  -u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
  "https://rest.nexmo.com/account/numbers?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

npm install @vonage/server-sdk

Create a file named list-numbers.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

View full source

Write the code

Add the following to list-numbers.js:

const run = async () => {
  try {
    const filter = {
      pattern: NUMBER_SEARCH_CRITERIA,
      searchPattern: NUMBER_SEARCH_PATTERN,
    };

    for await (const number of vonage.number.getOwnedNumbers(filter)) {
      console.log(number);
    }
  } catch (error) {
    console.error(error);
  }
};

run();

View full source

Run your code

Save this file to your machine and run it:

node list-numbers.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Create a file named ListOwnedNumbers and add the following code to the main method:

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

View full source

Write the code

Add the following to the main method of the ListOwnedNumbers file:

val numbers = client.numbers.listOwned {
    pattern(NUMBER_SEARCH_PATTERN, NUMBER_SEARCH_CRITERIA)
}
for (number in numbers) {
    println("""
        Tel: ${number.msisdn}
        Country: ${number.country}
        Type: ${number.type}
        """.trimIndent()
    )
}

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.vonage.quickstart.kt.numbers with the package containing ListOwnedNumbers:

gradle run -Pmain=com.vonage.quickstart.kt.numbers.ListOwnedNumbers

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

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

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

View full source

Write the code

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

List<OwnedNumber> response = client.getNumbersClient().listNumbers(
        ListNumbersFilter.builder()
                .pattern(NUMBER_SEARCH_PATTERN, NUMBER_SEARCH_CRITERIA)
                .build()
);

for (OwnedNumber number : response) {
    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.vonage.quickstart.numbers with the package containing ListNumbers:

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

Prerequisites

Install-Package Vonage

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

using Vonage;
using Vonage.Numbers;
using Vonage.Request;

View full source

Add the following to ListOwnedNumbers.cs:


var credentials = Credentials.FromApiKeyAndSecret(vonageApiKey, vonageApiSecret);

View full source

Write the code

Add the following to ListOwnedNumbers.cs:


var request = new NumberSearchRequest() 
{ 
    SearchPattern = numberSearchPattern, 
    Pattern = numberSearchCriteria 
};

View full source

Prerequisites

composer require vonage/client

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

$basic = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client($basic);

View full source

Write the code

Add the following to list-owned.php:

try {
    $filter = new \Vonage\Numbers\Filter\OwnedNumbers();
    $filter
        ->setPattern((int) NUMBER_SEARCH_CRITERIA)
        ->setSearchPattern((int) NUMBER_SEARCH_PATTERN)
    ;
    $response = $client->numbers()->searchOwned($filter);

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

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

View full source

Run your code

Save this file to your machine and run it:

php list-owned.php

Prerequisites

pip install vonage python-dotenv

Write the code

Add the following to list.py:

from vonage import Auth, Vonage
from vonage_numbers import ListOwnedNumbersFilter

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

numbers, count, next = client.numbers.list_owned_numbers(
    ListOwnedNumbersFilter(
        pattern=NUMBER_SEARCH_CRITERIA, search_pattern=NUMBER_SEARCH_PATTERN
    )
)

pprint(numbers)
print(count)
print(next)

View full source

Run your code

Save this file to your machine and run it:

python numbers/list.py

Prerequisites

gem install vonage

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

client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

View full source

Write the code

Add the following to list.rb:

response = client.numbers.list

View full source

Run your code

Save this file to your machine and run it:

ruby list.rb

List Your Numbers

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

Prerequisites

Write the code

Run your code

See also