Retrieve a TollFree Number
Retrieves the details of the specified TollFree number from the number pool resource.
API Endpoint
GET
https://api.plivo.com/v1/Account/{auth_id}/NumberPool/{numberpool_uuid}/Tollfree/{tolfree_number}/
Arguments
No arguments need to be passed.
Returns
This API call returns the details for the tollfree number identified by the tollfree number
specified in the request URL.
Response
HTTP Status Code: 200
{
"account_phone_number_resource": "/v1/Account/{auth_id}/Number/{your_tollfree_number}/",
"added_on": "2020-03-18T16:07:39.379739Z",
"api_id": "df0519d6-7ed4-11ea-b82e-0242ac110006",
"country_iso2": "US",
"number": "{your_tollfree_number}",
"number_pool_uuid": "{number_pool_uuid}",
"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>")
# Retrieve a Specific Tollfree Number
powerpack = client.powerpacks.get(uuid='<powerpack_uuid>')
# Version 1
response = powerpack.find_tollfree('<tollfree_number>')
# Version 2
response = powerpack.numberpool.tollfree.find('<tollfree_number>')
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
# Retrieve a Specific Tollfree Number
powerpack = api.powerpacks.get('<powerpack_uuid>')
# Version 1
response = powerpack.find_tollfree('<tollfree_number>')
# Version 2
response = powerpack.numberpool.tollfree.find('<tollfree_number>')
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>');
// Retrieve a Specific Tollfree Number
client.powerpacks.get("<powerpack_uuid>").then(
function (powerpack) {
return powerpack.find_tollfree("<tollfree>")
// return powerpack.number_pool.tollfree.find("<tollfree>"); 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);
// Retrieve a Specific Tollfree Number
try {
$powerpack = $client->powerpacks->get("<powerpack_uuid>");
// Version 1
$response = $powerpack->find_tollfree('<tollfree_number>');
// Version 2
$response = $powerpack->number_pool->tollfree->find('<tollfree_number>');
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
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>");
// Retrieve a Specific Tollfree Number
try
{
var powerpack = api.Powerpacks.Get("<poerpack_uuid>");
// Version 1
var response = powerpack.Find_Tollfree("<tollfree_number>");
// Version 2
var response = powerpack.numberpool.tollfree.Find("<tollfree_number>");
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)
}
// Retrieve a Specific Tollfree Number
powerpack, err := client.Powerpack.Get("<powerpack_uuid>")
if err != nil {
panic(err)
}
response, err := powerpack.Find_tollfree("<tollfree_number>")
if err != nil {
panic(err)
}
fmt.Printf("Response: %#v\n", response)
}
Rate this page
🥳 Thank you! It means a lot to us!
×
Help Us Improve
Thank you so much for rating the page, we would like to get your input for further improvements!
Subscribe to Updates
Thank you for your feedback!