ConferenceList allows you to get list of Conferences (and their Members) through one request.
You can mix some filters (see MemberFilter, CallUUIDFilter, MutedFilter and DeafFilter), to retrieve only some Members.

ConferenceList Request URL

To list conferences, make an HTTP POST to the below URL with the required parameters:

http://{BASEURL}/{ApiVersion}/ConferenceList/

POST Parameters

Required Parameters

You must POST the following parameters:

Parameter Description
MemberFilter A list of MemberID separated by comma.
If set only get the members matching the MemberIDs in list. (default empty)
CallUUIDFilter A list of CallUUID separated by comma.
If set only get the channels matching the CallUUIDs in list. (default empty)
MutedFilter ‘true’ or ‘false’. If ‘true’, only get muted members (default ‘false’)
DeafFilter ‘true’ or ‘false’. If ‘true’, only get deaf members (default ‘false’)

Response Parameters

When you initiate a RESTAPI, Plivo responds with the standard parameters as mentioned here. Along with that the following additional parameters are sent:

  • List: List of Conferences with settings (and with members) in json format.

Below is a json result example :

{
  "Message": "Conference List Executed",
  "List": {
    "Room-1": {
      "ConferenceMemberCount": "1",
      "ConferenceName": "Room-1",
      "ConferenceRunTime": "11",
      "ConferenceUUID": "3e883a74-22f7-4405-8b9c-ceeefda56ea8",
      "Members": [
        {
          "Muted": false,
          "Deaf": false,
          "MemberID": "7",
          "CallNumber": "1000",
          "CallName": "SIP1000",
          "CallUUID": "67feca4d-6672-43ca-96cc-68c993483c43",
          "JoinTime": "11"
        }
      ]
    },
    "Room-2": {
      "ConferenceMemberCount": "1",
      "ConferenceName": "Room-2",
      "ConferenceRunTime": "15",
      "ConferenceUUID": "6447277d-4d6d-40b2-8dd6-58b5f6b594b9",
      "Members": [
        {
          "Muted": false,
          "Deaf": false,
          "MemberID": "6",
          "CallNumber": "1001",
          "CallName": "SIP1001",
          "CallUUID": "f42161b2-b7b3-4897-a795-59b21536a771",
          "JoinTime": "15"
        }
      ]
    }
  },
  "Success": true
}

Leave a Reply