setWaitingRoomState

TrueConfAbout 1 min

setWaitingRoomState

Description: enabling and disabling the waiting room. v4.3.0+

Request example:

{
    "method" : "setWaitingRoomState",
    "requestId" : "1",
    "isUsersMustBeInvited": true,
    "enable" : true
}

Response example:

{
    "method" : "setWaitingRoomState",
    "requestId" : "1",
    "confId" : "00000080752eb399@some.server#vcs",
    "result" : true
}

Parameter description:

  • enable - a flag indicating whether to enable or disable the waiting room

  • isUsersMustBeInvited - a flag that should only be present if the waiting room is disabled (parameter enable = false), indicating what should happen to participants who are already in it:

    • false - participants in the waiting room are removed from the conference

    • true - participants who are in the waiting room are added to the conference.

  • confId - the unique identifier of the conference where the waiting room was enabled or disabled.

  • requestId - a unique request identifier. You can learn more about it here.

See also: