Chilkat Online Tools

phpAx / Plivo REST API / Retrieve a Number

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$http->BasicAuth = 1;
$http->Login = '{{auth_id}}';
$http->Password = 'password';

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/{number}/',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

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

?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Retrieve a Number",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/{number}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{number_pool_uuid}",
        "{number}",
        ""
      ]
    },
    "description": "Retrieves the details of the specified number from the number pool resource.\n[here](https://www.plivo.com/docs/sms/api/numberpool#retrieve-a-number)"
  },
  "response": [
    {
      "name": "Retrieve a Number",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/{number}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{number_pool_uuid}",
            "{number}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"account_phone_number_resource\": \"/v1/Account/{auth_id}/Number/{your_number}/\",\n    \"added_on\": \"2019-10-09T11:24:35.085797Z\",\n    \"api_id\": \"612982e8-0a87-11ea-b072-0242ac110007\",\n    \"country_iso2\": \"CA\",\n    \"number\": \"{your_number}\",\n    \"number_pool_uuid\": \"{number_pool_uuid}\",\n    \"type\": \"fixed\"\n}"
    }
  ]
}