Skip to navigation

Cancel a Number

If you no longer require a Vonage virtual number that you have purchased you can cancel it.

This page shows you how to cancel a number programmatically.

You can also cancel a number 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:

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).
COUNTRY_CODE The two digit country code for the number. For example: GB for the United Kingdom
VONAGE_NUMBER Your Vonage Number. E.g. 447700900000
  • cURL
  • Node.js
  • Java
  • .NET
  • PHP
  • Python
  • Ruby

    • Write the code

    Add the following to cancel-number.sh:

    curl -X POST \
  "https://rest.nexmo.com/number/cancel?api_key=$VONAGE_API_KEY&api_secret=$VONAGE_API_SECRET" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "country=$COUNTRY_CODE&msisdn=$VONAGE_NUMBER"

    View full source

    Run your code

    Save this file to your machine and run it: 

    sh cancel-number.sh

    Prerequisites

    npm install @vonage/server-sdk

    Create a file named cancel.js and add the following code:

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

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

    View full source

    Write the code

    Add the following to cancel.js:

    vonage.number.cancel(COUNTRY_CODE, VONAGE_NUMBER, (err, res) => {
  if(err) {
    console.error(err)
  }
  else {
    console.log(JSON.stringify(res, null, 2))
  }
})

    View full source

    Run your code

    Save this file to your machine and run it: 

    node cancel.js

    Prerequisites

    Add the following to `build.gradle`:

    compile 'com.vonage:client:6.2.0'

    Create a class named CancelNumber 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 CancelNumber class:

    NumbersClient numbersClient = client.getNumbersClient();

numbersClient.cancelNumber(COUNTRY_CODE, VONAGE_NUMBER);

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

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

    Prerequisites

    Install-Package Vonage

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

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

    View full source

    Add the following to CancelNumber.cs:

    var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);

    View full source

    Write the code

    Add the following to CancelNumber.cs:

    var request = new NumberTransactionRequest() { Country = COUNTRY_CODE, Msisdn = VONAGE_NUMBER };
var response = client.NumbersClient.CancelANumber(request);

    View full source

    Prerequisites

    composer require vonage/client

    Create a file named cancel.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 cancel.php:

    try {
  $client->numbers()->cancel(VONAGE_NUMBER);
  echo "Number cancelled";
}

catch(Exception $e) {
  echo "Error cancelling number";
}

    View full source

    Run your code

    Save this file to your machine and run it: 

    php cancel.php

    Prerequisites

    pip install vonage

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

    import vonage

client = vonage.Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)

    View full source

    Write the code

    Add the following to cancel.py:

    try:
    response = client.cancel_number({"country": COUNTRY_CODE, "msisdn": VONAGE_NUMBER})
    print("Number cancelled")
except Exception as exc:
    print("Error cancelling number", exc)

    View full source

    Run your code

    Save this file to your machine and run it: 

    python cancel.py

    Prerequisites

    gem install vonage

    Create a file named cancel.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 cancel.rb:

    begin
  response = client.numbers.cancel(
    country: COUNTRY_CODE,
    msisdn: VONAGE_NUMBER
  )
  puts "Number cancelled"
rescue
  puts "Error cancelling number"
end

    View full source

    Run your code

    Save this file to your machine and run it: 

    ruby cancel.rb

    See also

    Improve this page