Chilkat Online Tools

autoit / Plivo REST API / Get details of all ongoing calls

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "{{auth_id}}"
$oHttp.Password = "password"

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("status","live")
$oQueryParams.UpdateString("call_direction","outbound")
$oQueryParams.UpdateString("from_number","14152225555")
$oQueryParams.UpdateString("to_number","14152223333")

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/Call/",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -G -d "status=live"
	-d "call_direction
=outbound"
	-d "from_number=14152225555"
	-d "to_number=14152223333"
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Call/

Postman Collection Item JSON

{
  "name": "Get details of all ongoing calls",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/?status=live&call_direction\n=outbound&from_number=14152225555&to_number=14152223333",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Call",
        ""
      ],
      "query": [
        {
          "key": "status",
          "value": "live"
        },
        {
          "key": "call_direction\n",
          "value": "outbound",
          "description": "The direction of the call in case you would like to filter results by call direction. The valid values are ‘inbound’ and ‘outbound’."
        },
        {
          "key": "from_number",
          "value": "14152225555",
          "description": "The number from which the calls were made in case you would like to filter results by the number from which the call was made. You can filter the details by using the exact number or the desired prefix."
        },
        {
          "key": "to_number",
          "value": "14152223333",
          "description": "The destination number to which the calls were made in case you would like to filter results by destination called. You can filter the details by using the exact number or the desired prefix.\n"
        }
      ]
    },
    "description": "This method allows you to retrieve details of all ongoing calls made from an account.\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/call#retrieve-all-live-calls)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| call_direction      | SThe direction of the call in case you would like to filter results by call direction. The valid values are ‘inbound’ and ‘outbound’.| Optional  |\n| from_number   | The number from which the calls were made in case you would like to filter results by the number from which the call was made. You can filter the details by using the exact number or the desired prefix. | Optional      |\n| to_number   | The destination number to which the calls were made in case you would like to filter results by destination called. You can filter the details by using the exact number or the desired prefix. | Optional |"
  },
  "response": [
    {
      "name": "Get details of all ongoing calls",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Call",
            ""
          ],
          "query": [
            {
              "key": "status",
              "value": "live",
              "disabled": true
            },
            {
              "key": "call_direction\n",
              "value": "outbound",
              "description": "The direction of the call in case you would like to filter results by call direction. The valid values are ‘inbound’ and ‘outbound’.",
              "disabled": true
            },
            {
              "key": "from_number",
              "value": "14152225555",
              "description": "The number from which the calls were made in case you would like to filter results by the number from which the call was made. You can filter the details by using the exact number or the desired prefix.",
              "disabled": true
            },
            {
              "key": "to_number",
              "value": "14152223333",
              "description": "The destination number to which the calls were made in case you would like to filter results by destination called. You can filter the details by using the exact number or the desired prefix.\n",
              "disabled": true
            }
          ]
        }
      },
      "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}"
    }
  ]
}