Latest Legacy

Remove a number

Removes a number from a number pool.

API Endpoint

DELETE https://api.plivo.com/v1/Account/{auth_id}/NumberPool/{number_pool_uuid}/Number/{number}/

Arguments

unrentbooleanDefault is false if not specified.

Returns

This API call removes a number from a number pool identified by the number and number_pool_uuid specified in the request URL.

Response

HTTP Status Code: 200

{
    "api_id": "c378d44c-0a89-11ea-b072-0242ac110007",
    "response": "success"
}

Example Request 

1
2
3
4
5
6

import plivo
import json

client = plivo.RestClient('<auth_id>','<auth_token>')
powerpack = client.powerpacks.get(uuid="powerpack_uuid")
print str(powerpack.remove_number('your-number'))

1
2
3
4
5
6
7
8
9
10
11
12
13
14

require 'rubygems'
require 'plivo'
include Plivo
include Plivo::Exceptions

api = RestClient.new("<auth_id>","<auth_token>")
begin
  powerpack = api.powerpacks.get(uuid='powerpack_uuid')
  puts powerpack
  response = powerpack.remove_number(number='your_number',unrent= true)
  puts response
rescue PlivoRESTError => e
  puts 'Exception: ' + e.message
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

var plivo = require('plivo');
var client = new plivo.Client("<auth_id>","<auth_token>");

client.powerpacks.get("powerpack_uuid").then(
    function (powerpack) {
      return powerpack.remove_number(
       "<your_number>", true
      )
    })
  .then(function (result) {
    console.log(result)
  })
  .catch(function (response) {
    console.log(response);
  });

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<?php
require 'vendor/autoload.php';
use Plivo\RestClient;

$client = new RestClient("<auth_id>","<auth_token>");
$client->client->setTimeout(40);
try {
    $powerpack = $client->powerpacks->get("your-powerpack-uuid");
    $response = $powerpack->remove_number('your_number',['unrent'=>true]);
    print_r($response);
}
catch (PlivoRestException $ex) {
    print_r($ex);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

package com.plivo.api;

import com.plivo.api.models.powerpack.Numbers;
import com.plivo.api.models.powerpack.Powerpack;
import com.plivo.api.exceptions.PlivoRestException;

import java.io.IOException;

public class PowerpackTest {
  public static void main(String[] args) {
    Plivo.init("<auth_id>", "<auth_token>");
    try {
        Powerpack powerpack = Powerpack.getter("powerpack_uuid").get();
        powerpack.remove_number().number("<your_number>").delete();
    }
    catch (  PlivoRestException | IOException e ) {
        e.printStackTrace();
    }
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

using System;
using Plivo;
using Plivo.Exception;
using System.Collections.Generic;

namespace test_apps
{
    class Program
    {
        static void Main(string[] args)
        {
            var api = new PlivoApi("<auth_id>","<auth_token>");
            try
            {
                var response = api.Powerpacks.Get("powerpack_uuid");
                Console.WriteLine(response.Remove_Number("<your_number>"));
            }
            catch (PlivoRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }
        }
    }
}

1
2
3

curl -X DELETE -i --user auth_id:auth_token \
-H "Content-Type: application/json" \
https://api.plivo.com/v1/Account/{auth_id}/NumberPool/{number_pool_uuid}/Number/{number}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

package main

import (
	"fmt"

	plivo "github.com/plivo/plivo-go/v7"
)
s
func main() {

	client, err := plivo.NewClient("<auth_id>","<auth_token>", &plivo.ClientOptions{})
	if err != nil {
			fmt.Print("Error", err.Error())
			return
		}
	powerpack, err := client.Powerpack.Get("<powerpack_uuid>")
	if err != nil {
			fmt.Print("Error", err.Error())
			return
		}
	// Remove a Number
	response, err := powerpack.Remove_number("<your_number>", {
        Unrent: true,
	})
	fmt.Printf("Response: %#v\n", response)
}