Conference

Conference API lets you list all ongoing conferences on your account. It also lets you terminate all conferences or a particular conference.

The following actions can be performed with the Conference APIs.

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

Get All Conferences

Retrieves a list of all conferences which are active on your account. This API returns the names of all the ongoing conferences.

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

Arguments

None

Response

HTTP Status Code: 200

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

Details of a Conference

Retrieves the details of a particular conference.

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

Arguments

None

Response

HTTP Status Code: 200

{
  "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": "John",
      "direction": "inbound",
      "call_uuid": "acfbf0b5-12e0-4d74-85f7-fce15f8f07ec",
      "join_time": "590"
    }
  ],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}

Response Attributes

conference_name
string The name of the conference.
conference_run_time
string Time in seconds since the conference has been initiated.
conference_member_count
string Number of members in the conference.
muted
boolean Lets you know if the member is muted. If this value id true then the member is currently muted.
member_id
string The ID of the member with respect to this conference. This is unique to a particular conference.
deaf
string Denotes whether the member is currently deaf. If this value is true, then the member will not be able to hear the conversation taking place on the conference.
from
string The number from which the call was made to the conference. This can either be a PSTN number or a SIP endpoint.
to
string The conference bridge number. This can either be a Plivo number of a application URL
caller_name
string The name of the caller in case the call was made from a SIP endpoint. This field would be empty if no caller name was specified while making the call.
direction
string The direction of the call. The values can be 'inbound' or 'outbound'.
call_uuid
string The call_uuid of the call. This can be used to uniquely identify the call made to the conference.
join_time
string The time in seconds since this call has joined the conference

Hangup All Conferences

This API lets you hangup all ongoing conferences running on your account.

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

Arguments

None

Response

HTTP Status Code: 204

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

Hangup a Particular Conference

This API lets you hangup a particular conference by using the conference name.

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

Arguments

None

Response

HTTP Status Code: 204

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