Web Services Admin API

• Type 'W' is for Windows platform (deprecated)
  
  
• Type ‘W32’ is for Windows 32-bit
  
  
• Type ‘W64’ is for Windows 64-bit
  
  
• Type 'M' is for Mac OS platform
  
  
• Type ‘S’ is for Linux 32-bit rpm installer
  
  
• Type ‘T’ is for Linux 64-bit rpm installer
  
  
• Type ‘U’ is for Ubuntu Linux 32-bit deb installer
  
  
• Type ‘X’ is for Ubuntu Linux 64-bit deb installer
  
  
• Type ‘P’ is for VidyoPanorama 600 running Windows 32-bit
  
  
• Type ‘N’ is for VidyoPanorama 600 running Windows 64-bit
  
  
• Type ‘E’ is for VidyoPanorama 600 running Linux 32-bit
  
  
• Type ‘O’ is for VidyoPanorama 600 running Linux 64-bit
  
  
• Type ‘Q’ is for VidyoRoom running Windows 32-bit
  
  
• Type ‘Y’ is for VidyoRoom running Windows 64-bit
  
  
• Type ‘F’ is for VidyoRoom running Linux 32-bit
  
  
• Type ‘Z’ is for VidyoRoom running Linux 64-bit
  
  
• Type ‘B’ is for Softroom running Windows 64-bit
  
  
• Type ‘C’ is for Softroom running Windows 64-bit
  
  
• Type ‘D’ is Softroom running Mac OS 64-bit
  
  
• Type ‘L’ is for Linux (deprecated)

currentTag

EndpointVersionPattern

Specifies the tag of the endpoint version using a string pattern. Only a-z or A-Z or 0-9 or ‘.’ and ‘_’ are allowed.

Yes

EndpointUploadID

Integer

The endpoint upload ID of the newly created endpoint upload URL

Yes

endpointBehaviorkey

String

The mapping of the endpoint behavior.

Yes

Contains the parameters for all endpoint behavior configurations. These parameters may include the following:

• welcomePage (integer)
• beautyScreen (integer)
• loginModule (integer)
• publicChat (integer)
• leftPanel (integer)
• inCallSearch (integer)
• inviteParticipants (integer)
• contentSharing (integer)
• shareDialogOnJoin (integer)
• displayLabels (integer)
• remoteContentAccess (integer)
• cameraMuteControl (integer)
• muteCameraOnEntry (integer)
• audioMuteControl (integer)
• muteAudioOnEntry (integer)
• deviceSettings (integer)
• pinnedParticipant (integer)
• recordConference (integer)
• exitOnUserHangup (jnteger)
• automaticallyUpdate (integer)
• lockUserName (integer)
• enableAutoAnswer (integer)
• participantNotification (integer)
• fullScreenVideo (integer)

Optional Parameters

• windowSizeHeight (integer)
• windowSizeWidth (integer)
• windowPositionTop (integer)
• windowPositionBottom (integer)
• windowPositionLeft (integer)
• windowPositionRight (integer)
• recordingRole (string)
• preIframeUrl (string)
• preIframeSize (integer)
• topIframeUrl (string)
• topIframeSize (integer)
• leftIframeUrl (string)
• leftIframeSize (integer)
• rightIframeUrl (string)
• rightIframeSize (integer)
• bottomIframeUrl (string)
• bottomIframeSize (integer)
• postIframeUrl (string)
• postIframeSize (integer)
• endpointBehaviorKey (string)

NoEndpointBehaviorExistsFault

The endpoint behavior does not exist for the tenant

Contains the parameters for all endpoint behavior configurations. These parameters may include the following:

• welcomePage (integer)
• beautyScreen (integer)
• loginModule (integer)
• publicChat (integer)
• leftPanel (integer)
• inCallSearch (integer)
• inviteParticipants (integer)
• contentSharing (integer)
• shareDialogOnJoin (integer)
• displayLabels (integer)
• remoteContentAccess (integer)
• cameraMuteControl (integer)
• muteCameraOnEntry (integer)
• audioMuteControl (integer)
• muteAudioOnEntry (integer)
• deviceSettings (integer)
• pinnedParticipant (integer)
• recordConference (integer)
• exitOnUserHangup (jnteger)
• automaticallyUpdate (integer)
• lockUserName (integer)
• enableAutoAnswer (integer)
• participantNotification (integer)
• fullScreenVideo (integer)

Optional Parameters

• windowSizeHeight (integer)
• windowSizeWidth (integer)
• windowPositionTop (integer)
• windowPositionBottom (integer)
• windowPositionLeft (integer)
• windowPositionRight (integer)
• recordingRole (string)
• preIframeUrl (string)
• preIframeSize (integer)
• topIframeUrl (string)
• topIframeSize (integer)
• leftIframeUrl (string)
• leftIframeSize (integer)
• rightIframeUrl (string)
• rightIframeSize (integer)
• bottomIframeUrl (string)
• bottomIframeSize (integer)
• postIframeUrl (string)
• postIframeSize (integer)
• endpointBehaviorKey (string)

endpointBehaviorkey

String

The mapping of the endpoint behavior

Yes

NoEndpointBehaviorExistsFault

The endpoint behavior does not exist for the tenant

Contains the parameters for all endpoint behavior configurations. These parameters may include the following:

• welcomePage (integer)
• beautyScreen (integer)
• loginModule (integer)
• publicChat (integer)
• leftPanel (integer)
• inCallSearch (integer)
• inviteParticipants (integer)
• contentSharing (integer)
• shareDialogOnJoin (integer)
• displayLabels (integer)
• remoteContentAccess (integer)
• cameraMuteControl (integer)
• muteCameraOnEntry (integer)
• audioMuteControl (integer)
• muteAudioOnEntry (integer)
• deviceSettings (integer)
• pinnedParticipant (integer)
• recordConference (integer)
• exitOnUserHangup (jnteger)
• automaticallyUpdate (integer)
• lockUserName (integer)
• enableAutoAnswer (integer)
• participantNotification (integer)
• fullScreenVideo (integer)

Optional Parameters

• windowSizeHeight (integer)
• windowSizeWidth (integer)
• windowPositionTop (integer)
• windowPositionBottom (integer)
• windowPositionLeft (integer)
• windowPositionRight (integer)
• recordingRole (string)
• preIframeUrl (string)
• preIframeSize (integer)
• topIframeUrl (string)
• topIframeSize (integer)
• leftIframeUrl (string)
• leftIframeSize (integer)
• rightIframeUrl (string)
• rightIframeSize (integer)
• bottomIframeUrl (string)
• bottomIframeSize (integer)
• postIframeUrl (string)
• postIframeSize (integer)
• endpointBehaviorKey (string)

NoEndpointBehaviorExistsFault

The endpoint behavior does not exist for the tenant

endpointBehaviorkey

String

The mapping of the endpoint behavior.

No

OK

String

Acknowledges that the operation was made successfully

Yes

NoEndpointBehaviorExistsFault

The endpoint behavior does not exist for the tenant

start

integer

Starting row number to return

No

limit

integer

Maximum number of results to return

No

sortBy

string

Field to sort by

No

sortDir

sortDir

Sort ascending ("ASC") or descending ("DESC")

No

MemberFilter

MemberFilter

A MemberFilter object containing:

• memberName (string)
• roomExtension (string)
• RoleName
• groupName (string)
• status (string)

No

start

Integer

Starting row number to return

Yes

limit

Integer

Maximum number of results to return

Yes

sortBy

String

Field to sort by

Yes

MemberFilter

MemberFilter

A MemberFilter object containing:

• memberName (string)
• roomExtension (string)
• RoleName
• groupName (string)
• status (string)

Yes

total

total

The total number of possble results

Yes

Member

Member

The list of Member objects containing:

• memberID (EntityID)
• name (string)
• password (string)
• displayName (string)
• extension (string)
• Language
• RoleName
• groupName (string)
• proxyName (string)
• emailAddress (string)
• created (string)
• description (string)
• allowCallDirect (boolean)
• allowPersonalMeeting (boolean)
• locationTag (string)
• creationTime (dateTime)
• modificationTime (dateTime)

No

start

Integer

This is the beginning index of the search result.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value.

No

limit

Integer

This is the number of results that are being requested.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value.

No

sortBy

String:

• memberID
• name
• Display name
• extension

This is the field by which the requestor is asking the results to be sorted by.

Note: In the User API, entityID is used instead of memberID.

String:

• ASC
• DESC

This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending.

query

String:

• name
• Display name
• extension

This is the search string that uses all the above filter criteria.

Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results.

No

total

Integer

Total number of registered members

Yes

member

member

Member properties including name, display name, extension, email and others

No

MemberNotFoundFault

Member not found

memberID

EntityID

The filter type is used to trim down (filter) the search results

Yes

member

Member

Member properties including name, display name, extension, email, and others

Yes

memberID

Member

Member details

Yes

returnObjectInResponse

String

Sends a request to retrieve the object that has been created

No

OK

String

Acknowledges that the operation was made successfully

Yes

memberID

Member

Member details

Yes

member

Member

New member’s properties

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

MemberNotFoundFault

Member not found

memberID

EntityID

Unique member identifier

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

MemberNotFoundFault

Member not found

start

Integer

This is the beginning index of the search result.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value.

No

limit

Integer

This is the number of results that are being requested.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value.

No

sortBy

String:

• memberID
• name
• Display name
• extension

This is the field by which the requestor is asking the results to be sorted by.

Note: In the User API, entityID is used instead of memberID.

String

• ASC
• DESC

This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending.

query

String:

• name
• Display name
• extension

This is the search string that uses all the above filter criteria.

Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results.

No

total

Integer

Total number of registered members

Yes

No

NotLicensedFault

API is not licensed

Yes

Yes

RoomNotFoundFault

Room not found

Yes

roomProfile

RoomProfile

Specifies the room profile

Yes

Yes

roomProfileName

String

Specifies the auto mute configuration selection profiles. The new profiles are:

• 'VideoOnly' - will locally auto mute audio only
  
  
• 'AudioOnly' - will locally auto mute video only
  
  
• 'NoAudioAndVideo' - will auto mute both audio and video

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

Yes

total

Integer

Total number of profiles that are available

Yes

roomProfile

RoomProfile

Specifies the room profile

Yes

Yes

returnObjectInResponse

String

Sends a request to retrieve the object that has been created

No

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

roomID

EntityID

This is the ID of addressing room object in the VidyoPortal

Yes

room

Room

Room description including room name, room owner, and other properties

Yes

OK   

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

RoomNotFoundFault

Room not found

roomID

EntityID

This is the ID of addressing room object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

NotLicensedFault

The API is not licensed

RoomNotFoundFault

Room not found

roomID

EntityID

The unique room identifier

Yes

Enabled

Boolean

Specifies whether the room will be enabled (True) or disabled (False)

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

RoomNotFoundFault

Room not found

roomID

EntityID

The unique room identifier

Yes

Enabled

Boolean

Provides the status of the room as enabled (True) or disabled (False)

NotLicensedFault

The API is not licensed

RoomNotFoundFault

Room not found

Yes

Optional

Yes

NotLicensedFault

The API is not licensed

RoomNotFoundFault

Room not found

Yes

Optional

Enabled

Boolean

Provides the status of the room as enabled (True) or disabled (False)

NotLicensedFault

The API is not licensed

RoomNotFoundFault

Room not found

start

Integer

This is the beginning index of the search result.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value.

No

limit

Integer

This is the number of results that are being requested.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value.

No

sortBy

String:

• memberID
• name
• Display name
• extension

This is the field by which the requestor is asking the results to be sorted by.

Note: In the User API, entityID is used instead of memberID.

String

• ASC
• DESC

This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending.

query

String:

• name
• Display name
• extension

This is the search string that uses all the above filter criteria.

Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results.

No

total

Integer

Total number of registered members

Yes

group

Group

Group Description on the VidyoPortal including group name, max number of members, and other properties

No

NotLicensedFault

The API is not licensed

groupID

EntityID

This is an ID for addressing Group object in the VidyoPortal

Yes

group

Group

Group Description on the VidyoPortal including group name, max number of members, and other properties

Yes

NotLicensedFault

The API is not licensed

group

Group

Group Description on the VidyoPortal including group name, max number of members, and other properties

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

groupID

EntityID

This is an ID for addressing Group object in the VidyoPortal

Yes

group

Group

Group Description on the VidyoPortal including groupID, name, roomMaxUsers, userMaxBandWidthIn, userMaxBandWidthOut, description, allowRecording

Yes

OK

String

Yes

NotLicensedFault

The API is not licensed

groupID

EntityID

This is an ID for addressing Group object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conference

EntityID

This is an ID for addressing the room object in the VidyoPortal where the conference is started

Yes

Total

Integer

Total number of registered members

Yes

Entity

EntityID

This object is returned as a result of search for member, public room, or legacy device

No

conferenceID

EntityID

This is an ID for addressing the room object in the VidyoPortal where the conference is started

Yes

participantID

EntityID

This is an ID for addressing a Member object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

SeatLicenseExpiredFault

Seat license expired and needs to be renewed

conferenceID

EntityID

This is an ID for addressing the room object in the VidyoPortal where the conference is started

Yes

participantID

EntityID

This is an ID for addressing a Member object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

This is an ID for addressing the room object in the VidyoPortal where the conference is started

Yes

participantID

EntityID

This is an ID for addressing a Member object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

This is an ID for addressing the room object in the VidyoPortal where the conference is started

Yes

participantID

EntityID

This is an ID for addressing a Member object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

This is an ID for addressing the room object in the VidyoPortal where the conference is started

Yes

participantID

EntityID

This is an ID for addressing a Member object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

roomID

EntityID

This is an ID for addressing the room object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

roomID

EntityID

This is an ID for addressing the room object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

roomID

EntityID

This is an ID for addressing the room object in the VidyoPortal

Yes

pin

String

Room pin

No

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

roomID

EntityID

This is an ID for addressing the room object in the VidyoPortal

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

SeatLicenseExpiredFault

Seat license expired and needs to be renewed

(Always Empty)

N/A

Use only the HTTP Authentication header

N/A

Name

String

Feature names Ports, Seats, and Installs

Yes

MaxValue

String

Maximum number of Ports, Seats, and Installs that are licensed

Yes

CurrentValue

String

Used number of the Ports, Seats, and Installs

No

NotLicensedFault

The API is not licensed

SeatLicenseExpiredFault

Seat license expired and needs to be renewed

roomID

EntityID

This is an ID for addressing the room object in the VidyoPortal

Yes

pin

String

Specifies the Moderator PIN - used for creating and updating an existing PIN

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

roomID

EntityID

This is an ID for addressing the room object in the VidyoPortal

Yes

pin

String

Specifies the Moderator PIN - used for creating and updating an existing PIN

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

(Always Empty)

N/A

Use only the HTTP Authentication header

N/A

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

SeatLicenseExpiredFault

Seat license expired and needs to be renewed

start

Integer

This is the beginning index of the search result.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value.

No

limit

Integer

This is the number of results that are being requested.

Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value.

No

sortBy

String:

• memberID
• name
• Display name
• extension

This is the field by which the requestor is asking the results to be sorted by.

Note: In the User API, entityID is used instead of memberID.

String

• ASC
• DESC

This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending.

query

String:

• name
• Display name
• extension

This is the search string that uses all the above filter criteria.

Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results.

No

total

Integer

Total number of entities

Yes

location

Location

Location tag name

No

NotLicensedFault

The API is not licensed

(Always Empty)

N/A

Use only the HTTP Authentication header

N/A

scheduledRoomEnabled

Boolean

Indicates whether the Scheduled Room feature has been disabled on the tenant

NotLicensedFault

The API is not licensed

disableScheduledRoom

Boolean

Set the Scheduled Room feature on the tenant:

'1' | True (disable)

'0' | False (enable)

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

Yes

entityID

EntityID

Yes

OK

String

NotLicensedFault

The API is not licensed

setPrivateChatState

Boolean

Indicates whether the private chat is enabled (True) or disabled (False) on the tenant.

Private chat is enabled by default.

No

setPublicChatState

Boolean

Indicates whether the public chat is enabled (True) or disabled (False) on the tenant.

Public chat is enabled by default.

No

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

ChatNotAvailableInSuperFault

Chat was set to "Unavailable" by the Super Admin and therefore the chat states cannot be updated

conferenceID

EntityID

Yes

OK

String

Acknowledges that the operation was made successfully

NotLicensedFault

The API is not licensed

conferenceID

EntityID

Yes

OK

String

Acknowledges that the operation was made successfully

NotLicensedFault

The API is not licensed

conferenceID

EntityID

Yes

filter.<nnnn>

Filter

No

total

Integer

Number of participants

recorderID

Integer

Recorder ID of the recorder active in the conference

paused

Boolean

Recording status

webcast

Boolean

Is webcast enabled for the conference

lectureMode

Boolean

Is Lecture Mode on for this conference

LectureMode
Participant

LectureMode
Participant

Object of the participants list

NotLicensedFault

The API is not licensed

entityID

EntityID

Entity ID

participantID

EntityID

Entity ID

EntityType

EntityType

EntityType object. There are three types of entities in VidyoPortal: Member, Room, and Legacy

displayName

String

Display name

extension

String

Extension

audio

Boolean

Indicates whether the audio is muted

video

Boolean

Indicates whether the video is muted

appshare

Boolean

Indicates whether there is a content share

handRaised

Boolean

Indicates whether a hand is raised

presenter

Boolean

Indicates whether the participant is presenting

conferenceID

EntityID

Conference ID of the conference where the presentation is being held

Yes

participantID

EntityID

Participant ID of the participant who had raised hand that the moderator wishes to dismiss

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

Conference ID of the conference where the presentation is being held

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

Conference ID of the conference where the presentation is being held

Yes

participantID

EntityID

Participant ID of the participant who had raised hand that the moderator wishes to dismiss

Yes

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

conferenceID

EntityID

Conference ID of the conference where the presentation is being held

Yes

participantID

EntityID

Participant ID of the participant who had raised hand that the moderator wishes to dismiss

Yes

OK

String

NotLicensedFault

The API is not licensed

setWaitingRoomState

Integer

Indicates whether Waiting Room is:

• Disabled on the meetings in the tenant (0)
• Enabled and when the owner joins, the conference will begin (1)
• Enabled and a presenter should be assigned to the meeting (2)

The request parameter is optional, and no change will take place if a value is not provided.

No

supportedClientsOnly

Boolean

Specifies whether endpoints that do not support Presenter and Waiting Room modes cannot join the meeting (True) or are allowed in (False).

The request parameter is optional, and no change will take place if a value is not provided.

No

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

displayName

string

Display name of the public room

Yes

ownerName

string

Owner name of the public room

Yes

setInMyContacts

boolean

Specifies whether to add the public room to contact list

No

setLocked

boolean

Indicates whether the public room is locked

No

setPIN

string

Indicates whether the public room is pinned

No

description

string

Description of the public room

No

roomID

EntityID

EntityID of the newly created public room

Yes

extension

string

Extension of the public room.

Yes

roomURL

anyURI

URL for the public room.

Yes

inMyContacts

boolean

Indicates whether public room is in contact list

No

locked

boolean

Indicates whether public room is locked

No

hasPIN

boolean

Indicates whether public room has a PIN

No

NotLicensedFault

The API is not licensed

displayName

string

Display name of the public room

Yes

recurring

Integer

Unused days after which the room will be garbage collected

Optional

setPIN

Boolean

The room will be generated with a PIN

Optional

moderatorPIN

String

Specifies the Moderator PIN for the newly created room

Optional

extension

String

The room’s unique ID

pin

String

The room’s randomly generated PIN

inviteContent

String

Content of the invite text (will include the room URL, PIN, and extension)

roomURL

String

The room’s URL

inviteSubject

String

The email invitation subject

NotLicensedFault

The API is not licensed

participantID

EntityID

The participant to be transferred

Yes

conferenceID

EntityID

The destination conference

Yes

roomPIN

String

The PIN for the destination conference

No

OK

String

Acknowledges that the operation was made successfully

Yes

NotLicensedFault

The API is not licensed

• “Invalid ParticipantID” (when <= 0)
• “Invalid ConferenceID” (when <= 0)
• “ParticipantID is not a valid virtual endpoint”
• “Participant cannot be transferred to conference they are already in.”
• “ParticipantID for <participantID> belongs to other tenant”
• “Invalid ConferenceID and/or PIN”
  
  Applies the following cases:
  -DB error looking up conference
  -Conference does not exist
  -Conference belongs to other tenant
  -Personal or public room has a PIN but not provided or does not match
  
  Scheduled room validation errors for the following cases:
  -PIN not provided but is required
  -Ext/PIN validation fails via scheduled room API
  
  

• “Room is disabled.”
• “Room is locked.”
• "Room is full."

participantID

EntityID

Obtained from getParticipants

Yes

layout

String

Not validated by the VidyoPortal. Valid choices include:

• Gallery View
• Active Speaker
• Continuous Presence

No

maxParticipants

Integer

Not validated by the VidyoPortal. Valid choices include integers from 1 through 8.

No

OK

String

Acknowledges that the operation was made successfully

Yes