Skip to content

getConferences

TrueConf11/10/26About 4 min

Description: get information about the current conference.

{
    "method" : "getConferences",
    "requestId" : "1"
}

Answer examples:

{
    "method": "getConferences",
    "requestId" : "1",
    "confId": "000000819f902bb4@some.server#vcs",
    "id": "561849261795@some.server#vcs",
    "confType": 3,
    "isSmartMeeting" : false,
    "slideShowPresent": false,
    "duration": 3,
    "joinUrl": "http://192.168.6.1:8888/c/561849261795",
    "autoJoin": false,
    "confTitle": "Conference",
    "conferenceOwner": "user1@some.server/c7dfc565",
    "realTimeConferenceManagmentUrl": "http://192.168.6.1:8888/tools/real-time?k=00B240580E7166C7405B1C67AE242CC8326AE092&call_id=user1%40some.server%2Fc7dfc565&stream_id=000000819f902bb4%40some.server%23vcs&lang=en&mode=inapp&version=8.0.0&app=TrueConf_Room",
    "confState": 1,
    "isWaitingRoomSwitchingSupported": true,
    "isWaitingRoomEnabled": true,
    "maxParticipants": 450,
    "maxParticipantsOnPodium": 4,
    "result": true
}
{
    "method": "getConferences",
    "confId": "0000008243184a66@some.server#vcs",
    "id": "0000008243184a66@some.server#vcs",
    "type": "p2p",
    "direction": "outgoing",
    "peerId": "user2@some.server",
    "peerDn": "user2",
    "confState": 0,
    "result": true
}

Parameter description:

  • maxParticipantsOnPodium - this parameter is present only if the moderated TrueConf Room API is in session and indicates the maximum number of participants that can be on the podium simultaneously. The field is present only for smart meeting.

  • maxParticipants - this parameter is present only if the moderated TrueConf Room API is in session and indicates the maximum number of participants in the conference or call.

  • confType - this parameter is present only if a moderated role-based conference TrueConf Room API is in session and indicates its type. It can be

    • 0 — Video call

    • 1 - all on screen

    • 2 - video lecture

    • 3 - role-based

  • confId - a unique identifier for a communication session (may change between sessions)

  • id - a unique permanent session identifier on the server

  • isSmartMeeting - a flag indicating whether the current smart meeting is in the Automatic podium mode by VAD.

  • slideShowPresent — Flag showing whether slideshow is available. It can be true or false

  • confTitle - the name of the conference. This field is present only when TrueConf Room API is in a group conference.

  • duration — Conference duration in seconds

  • autoJoin - a flag that indicates the possibility of auto-joining a conference for other participants. This field is present only in a group conference created by TrueConf Room API

  • peerId - unique user identifier (TrueConf ID). This field is present only when the TrueConf Room API is in a video call.

  • peerDn - display name. This field is present only when TrueConf Room API is in a video call.

  • confState — the conference state. The following states are possible:

    • 0 - awaiting session establishment (an incoming or outgoing call is in progress)

    • 1 — the session has started

    • 2 — no session connection and no incoming or outgoing calls

conferenceOwner — Conference owner

  • joinUrl — the conference join link

  • realTimeConferenceManagmentUrl - the link for real-time meeting management. If the value is empty, the link is unavailable.

  • direction - call direction. This field is present only when TrueConf Room API is calling someone or when someone is calling them. It can be:

    • outgoing — Outgoing

    • incoming — Incoming

  • type - call type. This field is present only when TrueConf Room API is calling someone or when someone is calling them. It can be:

    • p2p — Video call

    • conference — Group conference

  • confTitle - the conference name. This field is present only when TrueConf Room API is an invitation to a group conference.

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

  • isWaitingRoomSwitchingSupported - a flag indicating whether it is possible to enable and disable the waiting room. This field is only present when creating a group conference and connecting to it as an owner or moderator.

  • isWaitingRoomEnabled - a flag indicating whether the waiting room is enabled. This field is present only when creating a group conference and joining it as an owner or moderator.

  • isInWaitingRoom - a flag indicating entry into the waiting room. This field is present only when creating a group conference and connecting to it as a regular participant.

See also: