Chilkat Online Tools

Ruby / Plivo REST API / Retrieve a Number

Back to Collection Items

require '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(true)
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}/{number}/",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

print "Response status code = " + http.get_LastStatus().to_s() + "\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}"
    }
  ]
}