Conference

/v0.1/ConferenceListMembers/

Retrieves the member list for a given conference

post/v0.1/ConferenceListMembers/

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/ConferenceListMembers/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

ConferenceNamestring required

Name of the conference

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

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

Response

Message'Conference ListMembers Executed' | 'ConferenceName Parameter must be present' | 'Conference ListMembers Failed to parse result' | 'Conference ListMembers Failed -- Conference not found' required

Response message

Successboolean required

Whether the request was successful or not

Listobject required

List of established conferences

Example response

{
  "Message": "Conference ListMembers 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"
        }
      ]
    }
  }
}

Changes

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