Chilkat Online Tools

VB.NET / Plivo REST API / List all Shortcodes

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "{{auth_id}}"
http.Password = "password"


Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.plivo.com/v1/Account/<auth_id>/NumberPool/{number_pool_uuid}/Shortcode/",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine("Response status code = " & http.LastStatus)
Debug.WriteLine(sbResponseBody.GetAsString())

Curl Command

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

Postman Collection Item JSON

{
  "name": "List all Shortcodes",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Shortcode/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "NumberPool",
        "{number_pool_uuid}",
        "Shortcode",
        ""
      ]
    },
    "description": "This API can be used to fetch a list of shortcodes 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-shortcodes)"
  },
  "response": [
    {
      "name": "List all Shortcodes",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Shortcode/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "NumberPool",
            "{number_pool_uuid}",
            "Shortcode",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"614b2776-0a88-11ea-b072-0242ac110007\",\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": \"\",\n        \"offset\": 0,\n        \"previous\": \"\",\n        \"total_count\": 1\n    },\n    \"objects\": [\n        {\n            \"added_on\": \"2019-10-09T11:10:59.741978Z\",\n            \"country_iso2\": \"US\",\n            \"number_pool_uuid\": \"{number_pool_uuid}\",\n            \"shortcode\": \"{your_shortcode}\"\n        }\n    ]\n}"
    }
  ]
}