Retrieve a shortcode
Retrieves the details of the specified shortcode from the number pool resource.
API Endpoint
GET
https://api.plivo.com/v1/Account/{auth_id}/NumberPool/{number_pool_uuid}/Shortcode/{shortcode}/
Arguments
No arguments need to be passed.
Returns
This API call returns the details for the shortcode identified by the shortcode
specified in the request URL.
Response
HTTP Status Code: 200
{
"added_on": "2019-10-09T11:10:59.741978Z",
"api_id": "b42933e8-0a88-11ea-b072-0242ac110007",
"country_iso2": "US",
"number_pool_uuid": "{number_pool_uuid}",
"shortcode": "{your_shortcode}"
}
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.find_shortcode("your_short_code"))
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.find_shortcode(shortcode='your_shortcode')
puts response
rescue PlivoRESTError => e
puts 'Exception: ' + e.message
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
var plivo = require('plivo');
var client = new plivo.Client('auth_id', 'auth_token');
client.powerpacks
.get("powerpack_uuid")
.then(function (powerpack) {
return powerpack.find_shortcode('your_shortcode');
})
.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->find_shortcode("your_shortcode");
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
package com.plivo.api;
import com.plivo.api.models.powerpack.Powerpack;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.powerpack.Shortcode;
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();
Shortcode response= powerpack.find_shortcod().shortcode("your_shortcode").get();
System.out.println(response);
}
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
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.Find_Shortcode("your_shortcode"));
}
catch (PlivoRestException e)
{
Console.WriteLine("Exception: " + e.Message);
}
}
}
}
1
2
3
curl -X GET -i --user auth_id:auth_token \
-H "Content-Type: application/json" \
https://api.plivo.com/v1/Account/{auth_id}/NumberPool/{number_pool_uuid}/Shortcode/{short_code}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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)
}
powerpack, err := client.Powerpack.Get("powerpack_uuid")
if err != nil {
panic(err)
}
response, err := powerpack.Find_shortcode('your_shortcode')
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!