Conference

/v0.1/ConferenceHold/

Put one or more conference members on hold

post/v0.1/ConferenceHold/

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/ConferenceHold/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 in question

FilePathstring required

Path/URI of the media file to be played as music-on-hold

MemberIDstring required

List of comma separated member IDs to be affected; all shorthand is available however it is not capable of playing back the music-on-hold (i.e. use specific member IDs when MOH is necessary)

Example request

{
  "ConferenceName": "Room402",
  "FilePath": "/var/local/media/sample.wav",
  "MemberID": "13,42"
}

Response

Message'Conference Hold Executed' | 'ConferenceName Parameter must be present' | 'MemberID Parameter must be present' | 'Conference Hold Failed -- Conference not found' required

Response message

Membersstring[]

List of affected members

Successboolean required

Whether the request was successful or not

Example response

{
  "Message": "Conference Hold Executed",
  "Members": [
    "13",
    "42"
  ],
  "Success": true
}

Changes

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