Chilkat Online Tools

Node.js / Plivo REST API / Retrieve a conference

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "{{auth_id}}";
    http.Password = "password";

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("Response status code = " + http.LastStatus);
    console.log(sbResponseBody.GetAsString());

}

chilkatExample();

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