Chilkat Online Tools

TCL / Plivo REST API / Retrieve a PHLO

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{auth_id}}"
CkHttp_put_Password $http "password"

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "phlo_id" "<PHLO_ID>"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://phlorunner.plivo.com/v1/phlo/{phlo_id}" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $queryParams

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