Chilkat Online Tools

C# / Plivo REST API / List all Numbers

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("starts_with","");
queryParams.UpdateString("type","");
queryParams.UpdateString("service","");
queryParams.UpdateString("country_iso2","");
queryParams.UpdateString("limit","");
queryParams.UpdateString("offset","");

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Number/",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

Curl Command

curl -G -d "starts_with="
	-d "type="
	-d "service="
	-d "country_iso2="
	-d "limit="
	-d "offset="
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Number/

Postman Collection Item JSON

{
  "name": "List all Numbers",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Number/?starts_with=&type=&service=&country_iso2=&limit=&offset=",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{number_pool_uuid}",
        "Number",
        ""
      ],
      "query": [
        {
          "key": "starts_with",
          "value": "",
          "description": "A comma separated list of prefixes.\nAssume the values provided exclude the country code prefix.\nA max of 10 prefixes may be specified."
        },
        {
          "key": "type",
          "value": "",
          "description": "fixed, tollfree or mobile. Note that local and national numbers should be considered as ‘fixed’"
        },
        {
          "key": "service",
          "value": "",
          "description": "sms or mms. Use this argument to filter the numbers by capability."
        },
        {
          "key": "country_iso2",
          "value": "",
          "description": "ISO2 code of the phone number country.\nThis attribute must be specified if starts_with filter has been specified."
        },
        {
          "key": "limit",
          "value": "",
          "description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20."
        },
        {
          "key": "offset",
          "value": "",
          "description": "Denotes the number of value items by which the results should be offset"
        }
      ]
    },
    "description": "This API can be used to fetch a list of numbers 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-numbers)\n\n| Arguments   | Description | Required/Conditional/Optional |\n| :---:       |    :----:   |          :---: |\n| starts_with | A comma separated list of prefixes. Assume the values provided exclude the country code prefix. A max of 10 prefixes may be specified. Throw 400 Bad Request if more than 10 prefixes are specified.| Optional  |\n| type | fixed, tollfree or mobile. Note that local and national numbers should be considered as ‘fixed’ | Optional  |\n| service | sms or mms. Use this argument to filter the numbers by capability. | Optional  |\n| country_iso2 | ISO2 code of the phone number country. This attribute must be specified if starts_with filter has been specified. | Conditional  |\n| limit | Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. | Optional  |\n| offset | Denotes the number of value items by which the results should be offset. | Optional  |"
  },
  "response": [
    {
      "name": "List all Numbers",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Number/?starts_with&type&service&country_iso2&limit&offset",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{number_pool_uuid}",
            "Number",
            ""
          ],
          "query": [
            {
              "key": "starts_with",
              "value": null,
              "description": "A comma separated list of prefixes.\nAssume the values provided exclude the country code prefix.\nA max of 10 prefixes may be specified."
            },
            {
              "key": "type",
              "value": null,
              "description": "fixed, tollfree or mobile. Note that local and national numbers should be considered as ‘fixed’"
            },
            {
              "key": "service",
              "value": null,
              "description": "sms or mms. Use this argument to filter the numbers by capability."
            },
            {
              "key": "country_iso2",
              "value": null,
              "description": "ISO2 code of the phone number country.\nThis attribute must be specified if starts_with filter has been specified."
            },
            {
              "key": "limit",
              "value": null,
              "description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20."
            },
            {
              "key": "offset",
              "value": null,
              "description": "Denotes the number of value items by which the results should be offset"
            }
          ]
        }
      },
      "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_number}/\",\n      \"added_on\": \"2020-03-18T16:07:39.379739Z\",\n      \"country_iso2\": \"US\",\n      \"number\": \"{your_number}\",\n      \"number_pool_uuid\": \"{number_pool_uuid}\",\n      \"service\": \"mms\",\n      \"type\": \"fixed\"\n    },\n   {\n      \"account_phone_number_resource\": \"/v1/Account/{auth_id}/Number/{your_number}/\",\n      \"added_on\": \"2020-03-18T16:07:39.379739Z\",\n      \"country_iso2\": \"US\",\n      \"number\": \"{your_number}\",\n      \"number_pool_uuid\": \"{number_pool_uuid}\",\n      \"service\": \"sms\",\n      \"type\": \"fixed\"\n    }\n    {\n      \"account_phone_number_resource\": \"/v1/Account/{auth_id}/Number/{your_number}/\",\n      \"added_on\": \"2019-10-09T11:24:35.085797Z\",\n      \"country_iso2\": \"CA\",\n      \"number\": \"{your_number}\",\n      \"number_pool_uuid\": \"{number_pool_uuid}\",\n      \"service\": \"sms\",\n      \"type\": \"fixed\"\n    }\n  ]\n}"
    }
  ]
}