Chilkat Online Tools

PowerBuilder / Plivo REST API / List all endpoints

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>/Endpoint/",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>/Endpoint/

Postman Collection Item JSON

{
  "name": "List all endpoints",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Endpoint",
        ""
      ]
    },
    "description": "Retrieves the details of all endpoints.\n\nMore information can be found [here](https://www.plivo.com/docs/voice/api/endpoint#list-all-endpoints)"
  },
  "response": [
    {
      "name": "List all endpoints",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Endpoint",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"30a0c8c2-110c-11e4-bd8a-12313f016a39\",\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": null,\n        \"offset\": 0,\n        \"previous\": null,\n        \"total_count\": 11\n    },\n    \"objects\": [\n        {\n            \"alias\": \"callme\",\n            \"application\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Application/33406267401237901/\",\n            \"endpoint_id\": \"32866729519064\",\n            \"resource_uri\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Endpoint/32866729519064/\",\n            \"sip_contact\": \"sip:callme140703093224@122.172.71.207:57563;ob\",\n            \"sip_expires\": \"2014-07-21 19:26:08\",\n            \"sip_registered\": \"true\",\n            \"sip_uri\": \"sip:callme140703093944@phone.plivo.com\",\n            \"sip_user_agent\": \"Telephone 1.1.4\",\n            \"sub_account\": null,\n            \"username\": \"callme140703093944\"\n        },\n        {\n            \"alias\": \"polycom\",\n            \"application\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Application/37961981447734951/\",\n            \"endpoint_id\": \"17551316589618\",\n            \"resource_uri\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Endpoint/17551316589618/\",\n            \"sip_registered\": \"false\",\n            \"sip_uri\": \"sip:polycom140506175228@phone.plivo.com\",\n            \"sub_account\": null,\n            \"username\": \"polycom140506175448\"\n        }\n    ]\n}"
    }
  ]
}