Chilkat Online Tools

phpAx / Plivo REST API / Retrieve a conference

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = '{{auth_id}}';
$http->Password = 'password';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print 'Response status code = ' . $http->LastStatus . "\n";
print $sbResponseBody->getAsString() . "\n";

?>

Curl Command

curl -X GET
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/

Postman Collection Item JSON

{
  "name": "Retrieve a conference",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Conference",
        "{conference_name}",
        ""
      ]
    },
    "description": "Retrieves the details of a particular conference.\n\nMore information can be found [here](https://www.plivo.com/docs/voice/api/conference#retrieve-a-conference)"
  },
  "response": [
    {
      "name": "Retrieve a conference",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Conference",
            "{conference_name}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"conference_name\": \"My Conf Room\",\n    \"conference_run_time\": \"590\",\n    \"conference_member_count\": \"1\",\n    \"members\": [\n        {\n            \"muted\": false,\n            \"member_id\": \"17\",\n            \"deaf\": false,\n            \"from\": \"1456789903\",\n            \"to\": \"1677889900\",\n            \"caller_name\": \"John\",\n            \"direction\": \"inbound\",\n            \"call_uuid\": \"acfbf0b5-12e0-4d74-85f7-fce15f8f07ec\",\n            \"join_time\": \"590\"\n        }\n    ],\n    \"api_id\": \"816e903e-58c4-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}