Chilkat Online Tools

Node.js / Plivo REST API / List all TollFree Number

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "{{auth_id}}";
    http.Password = "password";

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{numberpool_uuid}/Tollfree/",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("Response status code = " + http.LastStatus);
    console.log(sbResponseBody.GetAsString());

}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "List all TollFree Number",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{numberpool_uuid}/Tollfree/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{numberpool_uuid}",
        "Tollfree",
        ""
      ]
    },
    "description": "This API can be used to fetch a list of all tollfree numbers(presently only one tollfree) from the Number Pool based on number_pool_UUID specified in the resource URI. More information can be found [here](https://www.plivo.com/docs/sms/api/numberpool#list-all-tollfree)"
  },
  "response": [
    {
      "name": "List all TollFree Number",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{numberpool_uuid}/Tollfree/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{numberpool_uuid}",
            "Tollfree",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"06c15d7c-7ed5-11ea-855f-0242ac110003\",\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": \"\",\n        \"offset\": 0,\n        \"previous\": \"\",\n        \"total_count\": 1\n    },\n    \"objects\": [\n        {\n            \"account_phone_number_resource\": \"/v1/Account/{auth_id}/Number/{your_tollfree_number}/\",\n            \"added_on\": \"2019-10-09T11:24:35.085797Z\",\n            \"country_iso2\": \"US\",\n            \"number\": \"{your_tollfree_number}\",\n            \"number_pool_uuid\": \"{number_pool_uuid}\",\n            \"service\": \"mms\",\n            \"type\": \"tollfree\"\n        }\n    ]\n}"
    }
  ]
}