Chilkat Online Tools

SQL Server / Plivo REST API / List all endpoints

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{auth_id}}'
    EXEC sp_OASetProperty @http, 'Password', 'password'

    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.plivo.com/v1/Account/<auth_id>/Endpoint/', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END


    EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0
    EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody


END
GO

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}"
    }
  ]
}