Chilkat Online Tools

PureBasic / Plivo REST API / Retrieve a PHLO Run

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{auth_id}}")
    CkHttp::setCkPassword(http, "password")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://phlorunner.plivo.com/v1/phlo/{phlo_id}/runs/{run_id}",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-u '{{auth_id}}:password'
https://phlorunner.plivo.com/v1/phlo/{phlo_id}/runs/{run_id}

Postman Collection Item JSON

{
  "name": "Retrieve a PHLO Run",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/runs/{run_id}",
      "protocol": "https",
      "host": [
        "phlorunner",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "phlo",
        "{phlo_id}",
        "runs",
        "{run_id}"
      ]
    },
    "description": "More infomration can be found [here](https://www.plivo.com/docs/phlo/api/phlo#retrieve-a-phlo-run)"
  },
  "response": [
    {
      "name": "Retrieve a PHLO Run",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/runs/{run_id}",
          "protocol": "https",
          "host": [
            "phlorunner",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "phlo",
            "{phlo_id}",
            "runs",
            "{run_id}"
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"36989807-a76f-4555-84d1-9dfdccca7a80\",\n    \"phlo_id\": \"e564a84a-7910-4447-b16f-65c541dd552c\",\n    \"run_id\": \"b7df01fd-1cb0-404e-a0d1-21e69a610e84\",\n    \"call_uuids\": [\n        \"11e4f82c-069c-49f9-9fcb-54c6633e2cdb\"\n    ],\n    \"message_uuids\": [],\n    \"recording_ids\": []\n}"
    }
  ]
}