Chilkat Online Tools

PowerBuilder / Plivo REST API / Retrieve a TollFree number

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.BasicAuth = 1
loo_Http.Login = "{{auth_id}}"
loo_Http.Password = "password"

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{numberpool_uuid}/Tollfree/{tolfree_number}/",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

Write-Debug "Response status code = " + string(loo_Http.LastStatus)
Write-Debug loo_SbResponseBody.GetAsString()


destroy loo_Http
destroy loo_SbResponseBody

Curl Command

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

Postman Collection Item JSON

{
  "name": "Retrieve a TollFree number",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{numberpool_uuid}/Tollfree/{tolfree_number}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{numberpool_uuid}",
        "Tollfree",
        "{tolfree_number}",
        ""
      ]
    },
    "description": "Retrieves the details of the specified TollFree number from the number pool resource. More information can be found [here](https://www.plivo.com/docs/sms/api/numberpool#retrieve-a-tollfree)"
  },
  "response": [
    {
      "name": "Retrieve a TollFree number",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{numberpool_uuid}/Tollfree/{tolfree_number}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{numberpool_uuid}",
            "Tollfree",
            "{tolfree_number}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"account_phone_number_resource\": \"/v1/Account/{auth_id}/Number/{your_tollfree_number}/\",\n    \"added_on\": \"2020-03-18T16:07:39.379739Z\",\n    \"api_id\": \"df0519d6-7ed4-11ea-b82e-0242ac110006\",\n    \"country_iso2\": \"US\",\n    \"number\": \"{your_tollfree_number}\",\n    \"number_pool_uuid\": \"{number_pool_uuid}\",\n    \"type\": \"tollfree\"\n}"
    }
  ]
}