TrueConf

# getConferences

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 a moderated TrueConf Room is in a communication session and indicates the maximum number of participants that can be on the podium simultaneously. The field is only available for video layout

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

  • confType — The parameter is available only if TrueConf Room is in a call or conference and indicates call or conference type. It can be as follows:

    • 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

  • pinned - a flag indicating that a participant is pinned in the Automatic stage appearance by VAD mode. It is present only in video selector

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

  • confTitle — Conference name. This field is available only when TrueConf Room is in a group conference

  • duration — Conference duration in seconds

  • autoJoin — Flag showing whether it is possible to automatically join a conference for other participants. This field is available only in a group conference created by TrueConf Room

  • peerId — Unique user identifier TrueConf ID. The field is available only when an TrueConf Room is in a video call

  • peerDn — Display name. The field is available only when TrueConf Room is in a video call

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

    • 0 - waiting for the communication session to be established (incoming or outgoing call 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 - link for real-time meeting management. If the value is empty - the link is unavailable

  • direction — Call direction. The field is available only when TrueConf Room calls someone or when someone calls it. It can be as follows:

    • outgoing — Outgoing

    • incoming — Incoming

  • type — Call type. The field is available only when TrueConf Room calls someone or when someone calls it. It can be as follows:

    • p2p — Video call

    • conference — Group conference

  • confTitle — Conference name. The field is available only when TrueConf Room has received an invitation to join a group conference.

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

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

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

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

See also: