getConferenceParticipants

TrueConfAbout 4 min

getConferenceParticipants

Description: Get a list of conference participants and information about them.

Request example:

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

Response example:

{
    "method": "getConferenceParticipants",
    "requestId" : "1",
    "confId": "00000080752eb399@some.server#vcs",
    "participants": [{
            "peerId": "user1@some.server/d8a9cda9",
            "peerDn": "cherry man 🍒",
            "mic": 2,
            "video": 0,
            "slideShow": false,
            "leaderType": 1,
            "reaction": 0,
            "role": 2,
            "broadcast": true,
            "pinned": true
        },
        {
            "peerId": "user2@some.server/58f5dac7",
            "peerDn": "user2",
            "recordingMe": false,
            "recordingByMe": false,
            "mic": 1,
            "video": 0,
            "slideShow": false,
            "leaderType": 0,
            "reaction": 2,
            "role": 1,
            "broadcast": false,
            "pinned": false,
            "isInWaitingRoom": false,
        }
    ],
    "result": true
}

Parameter description:

  • peerId - unique user identifier (TrueConf ID)

  • peerDn — User display name

  • pinned - a flag indicating that a participant is pinned in the Automatic podium access by VAD mode. It is only present in the smart meeting.

  • confId — Unique identifier of an ongoing conference

  • broadcast — Flag showing whether a user is a presenter on the podium. It is available in role-based conferences only

  • role — User role. It is available in role-based conferences only. It can be as follows:

    • 0 — without changes

    • 1 — General

    • 2 — the conference owner

    • 3 - the user who requested to step up to the podium

    • 4 — the user who was invited to the podium

    • 5 — the user who is currently making an audio reply

  • mic — Microphone state flag. It can be as follows:

    • 0 — A device is missing or not selected

    • 1 - the device is selected but muted (audio capture is disabled)

    • 2 — A device is selected and enabled

  • recordingMe - a flag indicating whether the user is recording the video and audio stream from TrueConf Room API. The parameter may be absent.

  • recordingByMe - a flag that indicates whether TrueConf Room API is recording the video and audio streams from this user. This parameter may be absent.

  • video — Camera state flag. It can be as follows:

    • 0 — A device is missing or not selected

    • 1 — A device is selected but muted

    • 2 — A device is selected and enabled

  • slideShow — Flag showing whether this participant is showing slides.

  • extraVideo — Feed type. The parameter may be unavailable. It can have the following values:

    • 0 — Video shared from camera

    • 1 — Content sharing

    • 2 — Video shared from camera that cannot be switched to content

  • audioReceiving — reception of audio from a participant. The parameter is optional.

  • videoReceiving — reception of video from a participant. The parameter is optional.

  • leaderType — the type of participant. This parameter is unavailable for a video call. The following values are possible:

    • 0 — General

    • 1 — Conference owner

    • 2 — Operator

    • 3 — moderator

  • reaction - participant reaction, which can take one of the following values:

    • 0 - reaction not set

    • 1 - reaction equals Raise Hand

    • 2 - response is Yes

    • 3 - the response is No

    • 4 - reaction is Laugh

    • 5 - reaction is Applause

    • 6 - the reaction is Not at the desk

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

  • isInWaitingRoom - a flag indicating whether the conference participant is in the waiting room. This field is present only if the moderated role-based conference TrueConf Room API owner or moderator of the group conference, and the current object in the array is not TrueConf Room API

See also: