List all TollFree numbers

    This API can be used to fetch a list of all tollfree numbers(presently only one tollfree) from the Number Pool based on number_pool_UUID specified in the resource URI.

    API Endpoint

    GET https://api.plivo.com/v1/Account/{auth_id}/NumberPool/{numberpool_uuid}/Tollfree/

    Arguments

    No arguments need to be passed.

    Returns

    This API returns the list of tollfree numbers from the Number Pool.

    The API response also contains a meta field with the following fields:

    • limit: This the size of the page returned in the response.
    • next: The URL that points to the next page of results. (Is blank because only one tollfree can be present inside a numberpool)
    • offset: The offset for the page returned in the response.
    • previous: The URL that points to the previous page of results. (Is blank because only one tollfree can be present inside a numberpool)
    • total_count: The total number of records that match the specified filters. (Always 1)

    Response

    HTTP Status Code: 200

    {
      "api_id": "06c15d7c-7ed5-11ea-855f-0242ac110003",
      "meta": {
        "limit": 20,
        "next": "",
        "offset": 0,
        "previous": "",
        "total_count": 1
      },
      "objects": [
        {
          "account_phone_number_resource": "/v1/Account/{auth_id}/Number/{your_tollfree_number}/",
          "added_on": "2019-10-09T11:24:35.085797Z",
          "country_iso2": "US",
          "number": "{your_tollfree_number}",
          "number_pool_uuid": "{number_pool_uuid}",
          "service": "mms",
          "type": "tollfree"
        }
      ]
    }
    
    

    Example Request

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    
    import plivo
    
    client = plivo.RestClient(auth_id="<auth_id>", auth_token="<auth_token>")
    # List all Tollfree in a Powerpack
    powerpack = client.powerpacks.get(uuid='<powerpack_uuid>')
    # Version 1
    response = powerpack.list_tollfree()
    # Version 2
    response = powerpack.numberpool.tollfree.list()
    print(response)
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    
    require 'rubygems'
    require 'plivo'
    
    include Plivo
    include Plivo::Exceptions
    
    api = RestClient.new("<auth_id>", "auth_token")
    
    begin
    # List all tollfree numbers
    powerpack = api.powerpacks.get('<powerpack_uuid>')
    # Version 1
    response = powerpack.list_tollfree()  
    # Version 2
    response = response.numberpool.tollfree.list()
    
    puts(response)
    rescue PlivoRESTError => e
    puts 'Exception: ' + e.message
    end
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    
    let plivo = require('plivo');
    
    let client = new plivo.Client('<auth_id>', '<auth_token>');
    
    // List all Tollfree in a Powerpack
    client.powerpacks.get("<powerpack_uuid>").then(
      function (powerpack) {
        return powerpack.list_tollfree()
        // return powerpack.number_pool.tollfree.list()  V2
      })
    .then(function (result) {
      console.log(result)
    })
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    
    <?php
    require 'vendor/autoload.php';
    use Plivo\RestClient;
    
    $client = new RestClient("<auth_id>", "<auth_token>");
    $client->client->setTimeout(40);
    
    // List all Tollfree in a Powerpack
        try {
        $powerpack = $client->powerpacks->get("<powerpack_uuid>");
        // Version 1
        $response = $powerpack->list_tollfree();
        // Version 2
        $response = $powerpack->number_pool->tollfree->list();
        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
    21
    22
    23
    24
    25
    26
    27
    28
    
    package com.plivo.api;
    
    import java.io.IOException;
    import com.plivo.api.Plivo;
    import com.plivo.api.exceptions.PlivoRestException;
    import com.plivo.api.models.powerpack.Powerpack;
    import com.plivo.api.models.powerpack.Tollfree;
    import com.plivo.api.models.base.ListResponse;
    
    
    public class Test {
            
    public static void main(String[] args) {
            
        Plivo.init("<auth_id>", "<auth_token>");
    
            // List all Tollfree in a Powerpack
            try {
                Powerpack powerpack = Powerpack.getter("<powerpack_uuid>").get();
                // Version 1
                ListResponse<Tollfree> response = powerpack.list_tollfree().list();
                //Version 2
                ListResponse<Tollfree> response = powerpack.numberpool.tollfree.list().list();
            } 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
    25
    26
    27
    28
    29
    30
    
    using System;
    using System.Collections.Generic;
    using Plivo;
    using Plivo.Exception;
    
    namespace PlivoExamples
    {
        class Program
        {
            static void Main(string[] args)
            {
                var api = new PlivoApi("<auth_id>","<auth_token>");
    
                // List all Tollfree in a Powerpack
                try
                {
                    var powerpack = api.Powerpacks.Get("<powerpack_uuid>");
                    // Version 1
                    var response = powerpack.List_Tollfree();
                    // Version 2
                    var response = powerpack.numberpool.tollfree.List();
                    Console.WriteLine(response);
                }
                catch (PlivoRestException e)
                {
                    Console.WriteLine("Exception: " + e.Message);
                }
            }
        }
    }
    
    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
    27
    
    package main
    
    import (
    	"fmt"
    
    	plivo "github.com/plivo/plivo-go"
    )
    
    func main() {
    
    	client, err := plivo.NewClient("<auth_id>", "<auth_token>",
    		&plivo.ClientOptions{})
    	if err != nil {
    		panic(err)
    	}
    
    	// List all Tollfree in a Powerpack
    	powerpack, err := client.Powerpack.Get("<powerpack_uuid>")
    	if err != nil {
    		panic(err)
    	}
    	response, err := powerpack.List_tollfree()
    	if err != nil {
    		panic(err)
    	}
    	fmt.Printf("Response: %#v\n", response)
    }