Chilkat Online Tools

Node.js / Plivo REST API / Retrieve a PHLO

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

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

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("phlo_id","<PHLO_ID>");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://phlorunner.plivo.com/v1/phlo/{phlo_id}",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -G -d "phlo_id=%3CPHLO_ID%3E"
	-u '{{auth_id}}:password'
https://phlorunner.plivo.com/v1/phlo/{phlo_id}

Postman Collection Item JSON

{
  "name": "Retrieve a PHLO",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}?phlo_id=<PHLO_ID>",
      "protocol": "https",
      "host": [
        "phlorunner",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "phlo",
        "{phlo_id}"
      ],
      "query": [
        {
          "key": "phlo_id",
          "value": "<PHLO_ID>",
          "description": "Unique identifier for the PHLO. PHLO ID is available on your\nconsole."
        }
      ]
    },
    "description": "More information can be found [here](https://www.plivo.com/docs/phlo/api/phlo#retrieve-a-phlo)"
  },
  "response": [
    {
      "name": "Retrieve a PHLO",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}?phlo_id=<PHLO_ID>",
          "protocol": "https",
          "host": [
            "phlorunner",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "phlo",
            "{phlo_id}"
          ],
          "query": [
            {
              "key": "phlo_id",
              "value": "<PHLO_ID>",
              "description": "Unique identifier for the PHLO. PHLO ID is available on your\nconsole."
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"e4202a42-0419-43db-9889-c440d3167796\",\n    \"phlo_id\": \"4c1a9f23-7f56-4879-bb80-db856e1e7701\",\n    \"name\": \"SMS Notifications\",\n    \"created_on\": \"2019-01-30 09:20:08.617883+00:00\"\n}"
    }
  ]
}