Conference

The following actions can be performed with the Conference APIs.

  BaseURI: https://api.plivo.com/v1/Account/{auth_id}/Conference/

Retrieve List of All Conferences

  URI: https://api.plivo.com/v1/Account/{auth_id}/Conference/
  Method: GET

Parameters

None

Response

HTTP status: 200

JSON: 
{
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48",
  "conferences": [
    "My Conf Room"
  ]
}

Retrieve Details of a Particular Conference

  URI: https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/
  Method: GET

Parameters

None

Response

HTTP status: 200

JSON: 
{
  "conference_name": "My Conf Room"
  "conference_run_time": "590",
  "conference_member_count": "1",
  "members": [
    {
      "muted": false,
      "member_id": "17",
      "deaf": false,
      "from": "1456789903",
      "to": "1677889900",
      "caller_name": "Joe%20Doe",
      "direction": "inbound",
      "call_uuid": "acfbf0b5-12e0-4d74-85f7-fce15f8f07ec",
      "join_time": "590"
    }
  ],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"

JSON: 

{
  "conference_name": "My Conf Room"
  "conference_run_time": "590",
  "conference_member_count": "1",
  "members": [
    {
      "muted": false,
      "member_id": "17",
      "deaf": false,
      "from": "1456789903",
      "to": "1677889900",
      "caller_name": "Joe%20Doe",
      "direction": "inbound",
      "call_uuid": "acfbf0b5-12e0-4d74-85f7-fce15f8f07ec",
      "join_time": "590"
    }
  ],
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Hangup All Conferences

  URI: https://api.plivo.com/v1/Account/{auth_id}/Conference/
  Method: DELETE

Parameters

None

Response

HTTP status: 204

JSON: 
{
  "message": "all conferences hung up",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Hangup a Particular Conference

  URI: https://api.plivo.com/v1/Account/{auth_id}/Conference/{conference_name}/
  Method: DELETE

Parameters

None

Response

HTTP status: 204

JSON: 

{
  "message": "conference hung up",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

Asynchronous Mode

All Plivo APIs can be invoked in asynchronous mode with the inclusion of the callback_url parameter. Note: In asynchronous mode, you will only get back a response with the api_id. The response is sent to the callback_url which is fired immediately after execution of the Plivo API. See API Request and API Response for more information.

Asynchronous Parameters
Parameter Description
callback_url The URL that is notified by the API when the response is available and to which the response is sent.
callback_method The method used to notify the callback_url URL. Defaults to POST.
Asynchronous Response

The Asynchronous Response is sent in json format in the response field.

See the API Response section for more information.

Developers

Navigation