Chilkat Online Tools

Perl / Plivo REST API / Retrieve a Shortcode

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("{{auth_id}}");
$http->put_Password("password");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Shortcode/{shortcode}/",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print "Response status code = " . $http->get_LastStatus() . "\r\n";
print $sbResponseBody->getAsString() . "\r\n";

Curl Command

curl -X GET
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Shortcode/{shortcode}/

Postman Collection Item JSON

{
  "name": "Retrieve a Shortcode",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Shortcode/{shortcode}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{number_pool_uuid}",
        "Shortcode",
        "{shortcode}",
        ""
      ]
    },
    "description": "Retrieves the details of the specified shortcode from the number pool resource.More information can be found [here](https://www.plivo.com/docs/sms/api/numberpool#retrieve-a-shortcode)\n\n| Arguments   | Description | Required/Conditional/Optional |\n| :---:        |    :----:   |          :---: |\n| unrent     | Default is False if not specified.| Optional  |"
  },
  "response": [
    {
      "name": "Retrieve a Shortcode",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Shortcode/{shortcode}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{number_pool_uuid}",
            "Shortcode",
            "{shortcode}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"added_on\": \"2019-10-09T11:10:59.741978Z\",\n    \"api_id\": \"b42933e8-0a88-11ea-b072-0242ac110007\",\n    \"country_iso2\": \"US\",\n    \"number_pool_uuid\": \"{number_pool_uuid}\",\n    \"shortcode\": \"{your_shortcode}\"\n}"
    }
  ]
}