Conference

/v0.1/ConferenceList/

Returns a list of all established conferences

post/v0.1/ConferenceList/

Request

Base URL
https://eqivo.org (the document declares no server; this is the origin it was published from)
Auth
HTTP basic
TypeScript
https://skmtc.dev/eqivo/apis/eqivo-api/docs/v0.1/ConferenceList/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

MemberFilterstring

Restricts listed members to the provided values (comma separated member ID list)

CallUUIDFilterstring

Restricts listed calls to the provided values (comma separated call UUID list)

MutedFilterboolean

Restricts listed members to muted ones

DeafFilterboolean

Restricts listed members to deaf ones

Example request

{
  "MemberFilter": "13,42",
  "CallUUIDFilter": "872066e1-fd89-4c57-8733-93c113980bc9,55e4214a-604a-4b56-82e4-97834b0d524e"
}

Response

Message'Conference List Executed' | 'Conference List Failed to parse result' required

Response message

Successboolean required

Whether the request was successful or not

Listobject required

List of established conferences

Example response

{
  "Message": "Conference List Executed",
  "Success": true,
  "List": {
    "Room402": {
      "ConferenceMemberCount": "1",
      "ConferenceName": "Room402",
      "ConferenceRunTime": "79",
      "ConferenceUUID": "5105acbf-6d43-4d67-8536-19999924eba4",
      "Members": [
        {
          "Muted": false,
          "Deaf": false,
          "MemberID": "14",
          "CallNumber": "3985",
          "CallName": "DeskPhone985",
          "CallUUID": "8f72b48e-d97e-425a-a6e6-ae5a6a0dc231",
          "JoinTime": "79"
        }
      ]
    },
    "Room555": {
      "ConferenceMemberCount": "1",
      "ConferenceName": "Room555",
      "ConferenceRunTime": "28",
      "ConferenceUUID": "732fab2d-1bff-4b54-8d3e-bd937b8ff662",
      "Members": [
        {
          "Muted": false,
          "Deaf": false,
          "MemberID": "14",
          "CallNumber": "2002",
          "CallName": "GuestCenter2",
          "CallUUID": "f8a79c36-2567-479d-b4d9-08f4165f8767",
          "JoinTime": "28"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.