Chilkat Online Tools

C / Plivo REST API / Retrieve an endpoint

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;

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

    http = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"{{auth_id}}");
    CkHttp_putPassword(http,"password");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://api.plivo.com/v1/Account/<auth_id>/Endpoint/{endpoint_id}/",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    printf("Response status code = %d\n",CkHttp_getLastStatus(http));
    printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));


    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);

    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "Retrieve an endpoint",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/{endpoint_id}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Endpoint",
        "{endpoint_id}",
        ""
      ]
    },
    "description": "Retrieves the details of an existing endpoint.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/voice/api/endpoint#retrieve-an-endpoint)"
  },
  "response": [
    {
      "name": "When the endpoint is registered with a SIP client",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/{endpoint_id}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Endpoint",
            "{endpoint_id}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\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}"
    },
    {
      "name": "Retrieve an endpoint",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Endpoint/{endpoint_id}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Endpoint",
            "{endpoint_id}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"alias\": \"zumba\",\n    \"api_id\": \"39015de8-4fb3-11e4-a2d1-22000ac5040c\",\n    \"application\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Application/379619814477342321/\",\n    \"endpoint_id\": \"39452475478853\",\n    \"password\": \"8bc0002a467b8276aaaf47e92bc46b9f\",\n    \"resource_uri\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Endpoint/39452475478853/\",\n    \"sip_registered\": \"false\",\n    \"sip_uri\": \"sip:zumba141009125224@phone.plivo.com\",\n    \"sub_account\": null,\n    \"username\": \"zumba141009125224\"\n}"
    }
  ]
}