Chilkat Online Tools

lianja / Plivo REST API / Retrieve all queued calls

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "{{auth_id}}"
loHttp.Password = "password"

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("status","queued")

loResp = loHttp.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/Call/",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loQueryParams

Curl Command

curl -G -d "status=queued"
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Call/

Postman Collection Item JSON

{
  "name": "Retrieve all queued calls",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/?status=queued",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Call",
        ""
      ],
      "query": [
        {
          "key": "status",
          "value": "queued"
        }
      ]
    },
    "description": "This method allows you to retrieve details of all queued calls. The maximum number of results that can be fetched with a single API call is 20.\n\nMore information can be found [here](https://www.plivo.com/docs/voice/api/call#retrieve-all-queued-calls)"
  },
  "response": [
    {
      "name": "Retrieve all queued calls",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/?status=queued",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Call",
            ""
          ],
          "query": [
            {
              "key": "status",
              "value": "queued"
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"c9527676-5839-11e1-86da-6ff39efcb949\",\n    \"calls\": [\n        \"eac94337-b1cd-499b-82d1-b39bca50dc31\",\n        \"0a70a7fb-168e-4944-a846-4f3f4d2f96f1\"\n    ]\n}"
    }
  ]
}