createConference

Description: Create a group conference.

Receiving a positive response ("result" : true) indicates that the command has been accepted for execution. The result will be sent in a separate notification.

The successful conference start will be indicated in one of these ways:

Upon changing the current connection status to 5 in the appStateChanged notification.
On the conferenceCreated notification

Request example:

{
    "method" : "createConference",
    "requestId" : "1",
    "title" : "Code review",
    "confType" : "role",
    "autoAccept" : false,
    "useWaitingRoom" : true,
    "muteCamOnJoin" : false,
    "muteMicOnJoin" : false,
    "castersCount" : 4,
    "inviteList" : [
        "user1@some.server",
        "user2@some.server",
        "user3@some.server"
    ]
}

Response example:

{
    "method" : "createConference",
    "requestId" : "1",
    "result" : true
}

Parameter description:

title — Conference name
castersCount - the number of participants in a moderated role-based conference who can be on the stage at the same time (can be retrieved from the getTariffRestrictions command or the tariffRestrictionsChanged notification)
useWaitingRoom - a flag that enables the waiting room at the start of the conference. This is an optional parameter. If not specified, it defaults to false.
muteCamOnJoin - a flag that automatically mutes a participant's video capture device when they join a group conference. This parameter is optional. If not specified, the default value false will be used.
muteMicOnJoin - a flag that automatically mutes the audio capture device for a participant who has just joined a group conference. This is an optional parameter. If not specified, the default value will be false.
smartMeeting is a flag that initiates the video selector in the Automatic Take the Podium by VAD mode and should only be included if the video selector is started. This parameter is optional and defaults to false if not specified.
autoAccept — Flag allowing participants to automatically join conference
confType — Conference type. It can be as follows:
- symmetric — All on screen
- asymmetric — Video lecture
- role - Role-based
inviteList - an array of strings containing the unique user identifiers (TrueConf ID) to whom the conference invitation will be sent. Possible values:
- PeerId is supported. Within the application, it is automatically converted to CallId, and the command is executed with it. In this case, the invitation will be received by the user on all devices.
- CallId - supported. The user will receive the invitation on all devices.
- InstanceId - supported. The invitation will be received by the user on a specific application instance.
requestId - a unique request identifier. You can find more details about it here.

There is no need to include the account under which TrueConf Room API is authorized (i.e., yourself) in the inviteList, as it will automatically be added as the first participant in the role of owner.

See also: